office-gobmx/vcl/osx/a11ycomponentwrapper.mm
Patrick Luby 0735a4306d Related tdf#158914: fix memory leaks by calling (auto)release selectors
Found the following memory leaks using Xcode's Instruments application:

1. Posting an NSAccessibilityUIElementDestroyedNotification
   notification causes [ AquaA11yWrapper isAccessibilityElement ]
   to be called on the object so mark the object as disposed
   before posting the destroyed notification and test for disposed
   in all of the standard NSAccessibility selectors to prevent
   any calls to likely disposed C++ accessibility objects.

2. In [ AquaA11yWrapper accessibilityHitTest: ],
   [ AquaA11yFactory wrapperForAccessibleContext: ] already retains
   the returned object so retaining it until the next call to this
   selector can lead to a memory leak when dragging selected cells
   in Calc to a new location. So autorelease the object so that
   transient objects stay alive but not past the next clearing of
   the autorelease pool.

3. [ AquaA11ySelectionWrapper selectedChildrenAttributeForElement: ] is
   expected to return an autoreleased object.

4. [ AquaA11yFactory wrapperForAccessible: ] is not a getter. It
   expects the caller to release the returned object.

5. CreateNSString() is not a getter. It expects the caller to
   release the returned string.

Change-Id: I824740d7e3851b0c3e31e2c009860aa822c94222
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/168034
Reviewed-by: Patrick Luby <guibomacdev@gmail.com>
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Tested-by: Jenkins
2024-05-26 09:52:41 +02:00

105 lines
4.7 KiB
Text

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <quartz/utils.h>
#include "a11ycomponentwrapper.h"
#include "a11yrolehelper.h"
#include <com/sun/star/accessibility/AccessibleRole.hpp>
using namespace ::com::sun::star::accessibility;
using namespace ::com::sun::star::awt;
using namespace ::com::sun::star::uno;
// Wrapper for XAccessibleComponent and XAccessibleExtendedComponent
@implementation AquaA11yComponentWrapper : NSObject
+(id)sizeAttributeForElement:(AquaA11yWrapper *)wrapper {
Size size = [ wrapper accessibleComponent ] -> getSize();
NSSize nsSize = NSMakeSize ( static_cast<float>(size.Width), static_cast<float>(size.Height) );
return [ NSValue valueWithSize: nsSize ];
}
// TODO: should be merged with AquaSalFrame::VCLToCocoa... to a general helper method
+(id)positionAttributeForElement:(AquaA11yWrapper *)wrapper {
// VCL coordinates are in upper-left-notation, Cocoa likes it the Cartesian way (lower-left)
NSRect screenRect = [ [ NSScreen mainScreen ] frame ];
Size size = [ wrapper accessibleComponent ] -> getSize();
Point location = [ wrapper accessibleComponent ] -> getLocationOnScreen();
NSPoint nsPoint = NSMakePoint ( static_cast<float>(location.X), static_cast<float>( screenRect.size.height - size.Height - location.Y ) );
return [ NSValue valueWithPoint: nsPoint ];
}
+(id)descriptionAttributeForElement:(AquaA11yWrapper *)wrapper {
if ( [ wrapper accessibleExtendedComponent ] ) {
// Related tdf#158914: explicitly call autorelease selector
// CreateNSString() is not a getter. It expects the caller to
// release the returned string.
return [ CreateNSString ( [ wrapper accessibleExtendedComponent ] -> getToolTipText() ) autorelease ];
} else {
return nil;
}
}
+(void)addAttributeNamesTo:(NSMutableArray *)attributeNames {
NSAutoreleasePool * pool = [ [ NSAutoreleasePool alloc ] init ];
[ attributeNames addObjectsFromArray: [ NSArray arrayWithObjects:
NSAccessibilitySizeAttribute,
NSAccessibilityPositionAttribute,
NSAccessibilityFocusedAttribute,
NSAccessibilityEnabledAttribute,
nil ] ];
[ pool release ];
}
+(BOOL)isAttributeSettable:(NSString *)attribute forElement:(AquaA11yWrapper *)wrapper {
bool isSettable = false;
NSAutoreleasePool * pool = [ [ NSAutoreleasePool alloc ] init ];
if ( [ attribute isEqualToString: NSAccessibilityFocusedAttribute ]
&& ! [ [ AquaA11yRoleHelper getNativeRoleFrom: [ wrapper accessibleContext ] ] isEqualToString: NSAccessibilityScrollBarRole ]
&& ! [ [ AquaA11yRoleHelper getNativeRoleFrom: [ wrapper accessibleContext ] ] isEqualToString: NSAccessibilityStaticTextRole ] ) {
isSettable = true;
}
[ pool release ];
return isSettable;
}
+(void)setFocusedAttributeForElement:(AquaA11yWrapper *)wrapper to:(id)value {
if ( [ value boolValue ] == YES ) {
if ( [ wrapper accessibleContext ] -> getAccessibleRole() == AccessibleRole::COMBO_BOX ) {
// special treatment for comboboxes: find the corresponding PANEL and set focus to it
Reference < XAccessible > rxParent = [ wrapper accessibleContext ] -> getAccessibleParent();
if ( rxParent.is() ) {
Reference < XAccessibleContext > rxContext = rxParent->getAccessibleContext();
if ( rxContext.is() && rxContext -> getAccessibleRole() == AccessibleRole::PANEL ) {
Reference < XAccessibleComponent > rxComponent( rxParent -> getAccessibleContext(), UNO_QUERY );
if ( rxComponent.is() ) {
rxComponent -> grabFocus();
}
}
}
} else {
[ wrapper accessibleComponent ] -> grabFocus();
}
}
}
@end
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */