/*

 * Copyright (c) 2011, 2018, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

// External Java Accessibility links:

//

// <https://docs.oracle.com/javase/8/docs/technotes/guides/access/index.html>

// <http://www-106.ibm.com/developerworks/library/j-access/?n-j-10172>

// <http://archives.java.sun.com/archives/java-access.html> (Sun's mailing list for Java accessibility)

#import "JavaComponentAccessibility.h"

#import "sun_lwawt_macosx_CAccessibility.h"

#import <AppKit/AppKit.h>

#import <JavaNativeFoundation/JavaNativeFoundation.h>

#import <JavaRuntimeSupport/JavaRuntimeSupport.h>

#import <dlfcn.h>

#import "JavaAccessibilityAction.h"

#import "JavaAccessibilityUtilities.h"

#import "JavaTextAccessibility.h"

#import "ThreadUtilities.h"

#import "AWTView.h"

// these constants are duplicated in CAccessibility.java

#define JAVA_AX_ALL_CHILDREN (-1)

#define JAVA_AX_SELECTED_CHILDREN (-2)

#define JAVA_AX_VISIBLE_CHILDREN (-3)

// If the value is >=0, it's an index

static JNF_STATIC_MEMBER_CACHE(jm_getChildrenAndRoles, sjc_CAccessibility, "getChildrenAndRoles", "(Ljavax/accessibility/Accessible;Ljava/awt/Component;IZ)[Ljava/lang/Object;");

static JNF_STATIC_MEMBER_CACHE(jm_getTableInfo, sjc_CAccessibility, "getTableInfo", "(Ljavax/accessibility/Accessible;Ljava/awt/Component;I)I");

static JNF_STATIC_MEMBER_CACHE(sjm_getAccessibleComponent, sjc_CAccessibility, "getAccessibleComponent", "(Ljavax/accessibility/Accessible;Ljava/awt/Component;)Ljavax/accessibility/AccessibleComponent;");

static JNF_STATIC_MEMBER_CACHE(sjm_getAccessibleValue, sjc_CAccessibility, "getAccessibleValue", "(Ljavax/accessibility/Accessible;Ljava/awt/Component;)Ljavax/accessibility/AccessibleValue;");

static JNF_STATIC_MEMBER_CACHE(sjm_getAccessibleName, sjc_CAccessibility, "getAccessibleName", "(Ljavax/accessibility/Accessible;Ljava/awt/Component;)Ljava/lang/String;");

static JNF_STATIC_MEMBER_CACHE(sjm_getAccessibleDescription, sjc_CAccessibility, "getAccessibleDescription", "(Ljavax/accessibility/Accessible;Ljava/awt/Component;)Ljava/lang/String;");

static JNF_STATIC_MEMBER_CACHE(sjm_isFocusTraversable, sjc_CAccessibility, "isFocusTraversable", "(Ljavax/accessibility/Accessible;Ljava/awt/Component;)Z");

static JNF_STATIC_MEMBER_CACHE(sjm_getAccessibleIndexInParent, sjc_CAccessibility, "getAccessibleIndexInParent", "(Ljavax/accessibility/Accessible;Ljava/awt/Component;)I");

static JNF_CLASS_CACHE(sjc_CAccessible, "sun/lwawt/macosx/CAccessible");

static JNF_MEMBER_CACHE(jf_ptr, sjc_CAccessible, "ptr", "J");

static JNF_STATIC_MEMBER_CACHE(sjm_getCAccessible, sjc_CAccessible, "getCAccessible", "(Ljavax/accessibility/Accessible;)Lsun/lwawt/macosx/CAccessible;");

static jobject sAccessibilityClass = NULL;

// sAttributeNamesForRoleCache holds the names of the attributes to which each java

// AccessibleRole responds (see AccessibleRole.java).

// This cache is queried before attempting to access a given attribute for a particular role.

static NSMutableDictionary *sAttributeNamesForRoleCache = nil;

static NSObject *sAttributeNamesLOCK = nil;

@interface TabGroupAccessibility : JavaComponentAccessibility {

    NSInteger _numTabs;

}

- (id)currentTabWithEnv:(JNIEnv *)env withAxContext:(jobject)axContext;

- (NSArray *)tabControlsWithEnv:(JNIEnv *)env withTabGroupAxContext:(jobject)axContext withTabCode:(NSInteger)whichTabs allowIgnored:(BOOL)allowIgnored;

- (NSArray *)contentsWithEnv:(JNIEnv *)env withTabGroupAxContext:(jobject)axContext withTabCode:(NSInteger)whichTabs allowIgnored:(BOOL)allowIgnored;

- (NSArray *)initializeAttributeNamesWithEnv:(JNIEnv *)env;

- (NSArray *)accessibilityArrayAttributeValues:(NSString *)attribute index:(NSUInteger)index maxCount:(NSUInteger)maxCount;

- (NSArray *)accessibilityChildrenAttribute;

- (id) accessibilityTabsAttribute;

- (BOOL)accessibilityIsTabsAttributeSettable;

- (NSArray *)accessibilityContentsAttribute;

- (BOOL)accessibilityIsContentsAttributeSettable;

- (id) accessibilityValueAttribute;

@end

@interface TabGroupControlAccessibility : JavaComponentAccessibility {

    jobject fTabGroupAxContext;

}

- (id)initWithParent:(NSObject *)parent withEnv:(JNIEnv *)env withAccessible:(jobject)accessible withIndex:(jint)index withTabGroup:(jobject)tabGroup withView:(NSView *)view withJavaRole:(NSString *)javaRole;

- (jobject)tabGroup;

- (void)getActionsWithEnv:(JNIEnv *)env;

- (id)accessibilityValueAttribute;

@end

@interface ScrollAreaAccessibility : JavaComponentAccessibility {

}

- (NSArray *)initializeAttributeNamesWithEnv:(JNIEnv *)env;

- (NSArray *)accessibilityContentsAttribute;

- (BOOL)accessibilityIsContentsAttributeSettable;

- (id)accessibilityVerticalScrollBarAttribute;

- (BOOL)accessibilityIsVerticalScrollBarAttributeSettable;

- (id)accessibilityHorizontalScrollBarAttribute;

- (BOOL)accessibilityIsHorizontalScrollBarAttributeSettable;

@end

@interface TableAccessibility : JavaComponentAccessibility {

}

- (NSArray *)initializeAttributeNamesWithEnv:(JNIEnv *)env;

- (NSArray *)accessibilityRowsAttribute;

- (NSArray *)accessibilityColumnsAttribute;

@end

@implementation JavaComponentAccessibility

- (NSString *)description

{

    return [NSString stringWithFormat:@"%@(title:'%@', desc:'%@', value:'%@')", [self accessibilityRoleAttribute],

        [self accessibilityTitleAttribute], [self accessibilityRoleDescriptionAttribute], [self accessibilityValueAttribute]];

}

- (id)initWithParent:(NSObject *)parent withEnv:(JNIEnv *)env withAccessible:(jobject)accessible withIndex:(jint)index withView:(NSView *)view withJavaRole:(NSString *)javaRole

{

    self = [super init];

    if (self)

    {

        fParent = [parent retain];

        fView = [view retain];

        fJavaRole = [javaRole retain];

        fAccessible = (*env)->NewWeakGlobalRef(env, accessible);

        (*env)->ExceptionClear(env); // in case of OOME

        jobject jcomponent = [(AWTView *)fView awtComponent:env];

        fComponent = (*env)->NewWeakGlobalRef(env, jcomponent);

        (*env)->DeleteLocalRef(env, jcomponent);

        fIndex = index;

        fActions = nil;

        fActionsLOCK = [[NSObject alloc] init];

    }

    return self;

}

- (void)unregisterFromCocoaAXSystem

{

    AWT_ASSERT_APPKIT_THREAD;

    static dispatch_once_t initialize_unregisterUniqueId_once;

    static void (*unregisterUniqueId)(id);

    dispatch_once(&initialize_unregisterUniqueId_once, ^{

        void *jrsFwk = dlopen("/System/Library/Frameworks/JavaVM.framework/Frameworks/JavaRuntimeSupport.framework/JavaRuntimeSupport", RTLD_LAZY | RTLD_LOCAL);

        unregisterUniqueId = dlsym(jrsFwk, "JRSAccessibilityUnregisterUniqueIdForUIElement");

    });

    if (unregisterUniqueId) unregisterUniqueId(self);

}

- (void)dealloc

{

    [self unregisterFromCocoaAXSystem];

    JNIEnv *env = [ThreadUtilities getJNIEnvUncached];

    (*env)->DeleteWeakGlobalRef(env, fAccessible);

    fAccessible = NULL;

    (*env)->DeleteWeakGlobalRef(env, fComponent);

    fComponent = NULL;

    [fParent release];

    fParent = nil;

    [fNSRole release];

    fNSRole = nil;

    [fJavaRole release];

    fJavaRole = nil;

    [fView release];

    fView = nil;

    [fActions release];

    fActions = nil;

    [fActionsLOCK release];

    fActionsLOCK = nil;

    [super dealloc];

}

- (void)postValueChanged

{

    AWT_ASSERT_APPKIT_THREAD;

    NSAccessibilityPostNotification(self, NSAccessibilityValueChangedNotification);

}

- (void)postSelectedTextChanged

{

    AWT_ASSERT_APPKIT_THREAD;

    NSAccessibilityPostNotification(self, NSAccessibilitySelectedTextChangedNotification);

}

- (void)postSelectionChanged

{

    AWT_ASSERT_APPKIT_THREAD;

    NSAccessibilityPostNotification(self, NSAccessibilitySelectedChildrenChangedNotification);

}

-(void)postTitleChanged

{

    AWT_ASSERT_APPKIT_THREAD;

    NSAccessibilityPostNotification(self, NSAccessibilityTitleChangedNotification);

}

- (void)postMenuOpened

{

    AWT_ASSERT_APPKIT_THREAD;

    NSAccessibilityPostNotification(self, (NSString *)kAXMenuOpenedNotification);

}

- (void)postMenuClosed

{

    AWT_ASSERT_APPKIT_THREAD;

    NSAccessibilityPostNotification(self, (NSString *)kAXMenuClosedNotification);

}

- (void)postMenuItemSelected

{

    AWT_ASSERT_APPKIT_THREAD;

    NSAccessibilityPostNotification(self, (NSString *)kAXMenuItemSelectedNotification);

}

- (BOOL)isEqual:(id)anObject

{

    if (![anObject isKindOfClass:[self class]]) return NO;

    JavaComponentAccessibility *accessibility = (JavaComponentAccessibility *)anObject;

    JNIEnv* env = [ThreadUtilities getJNIEnv];

    return (*env)->IsSameObject(env, accessibility->fAccessible, fAccessible);

}

- (BOOL)isAccessibleWithEnv:(JNIEnv *)env forAccessible:(jobject)accessible

{

    return (*env)->IsSameObject(env, fAccessible, accessible);

}

+ (void)initialize

{

    if (sAttributeNamesForRoleCache == nil) {

        sAttributeNamesLOCK = [[NSObject alloc] init];

        sAttributeNamesForRoleCache = [[NSMutableDictionary alloc] initWithCapacity:60];

    }

    if (sRoles == nil) {

        initializeRoles();

    }

    if (sAccessibilityClass == NULL) {

        JNF_STATIC_MEMBER_CACHE(jm_getAccessibility, sjc_CAccessibility, "getAccessibility", "([Ljava/lang/String;)Lsun/lwawt/macosx/CAccessibility;");

#ifdef JAVA_AX_NO_IGNORES

        NSArray *ignoredKeys = [NSArray array];

#else

        NSArray *ignoredKeys = [sRoles allKeysForObject:JavaAccessibilityIgnore];

#endif

        jobjectArray result = NULL;

        jsize count = [ignoredKeys count];

        JNIEnv *env = [ThreadUtilities getJNIEnv];

        static JNF_CLASS_CACHE(jc_String, "java/lang/String");

        result = JNFNewObjectArray(env, &jc_String, count);

        if (!result) {

            NSLog(@"In %s, can't create Java array of String objects", __FUNCTION__);

            return;

        }

        NSInteger i;

        for (i = 0; i < count; i++) {

            jstring jString = JNFNSToJavaString(env, [ignoredKeys objectAtIndex:i]);

            (*env)->SetObjectArrayElement(env, result, i, jString);

            (*env)->DeleteLocalRef(env, jString);

        }

        sAccessibilityClass = JNFCallStaticObjectMethod(env, jm_getAccessibility, result); // AWT_THREADING Safe (known object)

    }

}

+ (void)postFocusChanged:(id)message

{

    AWT_ASSERT_APPKIT_THREAD;

    NSAccessibilityPostNotification([NSApp accessibilityFocusedUIElement], NSAccessibilityFocusedUIElementChangedNotification);

}

+ (jobject) getCAccessible:(jobject)jaccessible withEnv:(JNIEnv *)env {

    if (JNFIsInstanceOf(env, jaccessible, &sjc_CAccessible)) {

        return jaccessible;

    } else if (JNFIsInstanceOf(env, jaccessible, &sjc_Accessible)) {

        return JNFCallStaticObjectMethod(env, sjm_getCAccessible, jaccessible);

    }

    return NULL;

}

+ (NSArray *)childrenOfParent:(JavaComponentAccessibility *)parent withEnv:(JNIEnv *)env withChildrenCode:(NSInteger)whichChildren allowIgnored:(BOOL)allowIgnored

{

    if (parent->fAccessible == NULL) return nil;

    jobjectArray jchildrenAndRoles = (jobjectArray)JNFCallStaticObjectMethod(env, jm_getChildrenAndRoles, parent->fAccessible, parent->fComponent, whichChildren, allowIgnored); // AWT_THREADING Safe (AWTRunLoop)

    if (jchildrenAndRoles == NULL) return nil;

    jsize arrayLen = (*env)->GetArrayLength(env, jchildrenAndRoles);

    NSMutableArray *children = [NSMutableArray arrayWithCapacity:arrayLen/2]; //childrenAndRoles array contains two elements (child, role) for each child

    NSInteger i;

    NSUInteger childIndex = (whichChildren >= 0) ? whichChildren : 0; // if we're getting one particular child, make sure to set its index correctly

    for(i = 0; i < arrayLen; i+=2)

    {

        jobject /* Accessible */ jchild = (*env)->GetObjectArrayElement(env, jchildrenAndRoles, i);

        jobject /* String */ jchildJavaRole = (*env)->GetObjectArrayElement(env, jchildrenAndRoles, i+1);

        NSString *childJavaRole = nil;

        if (jchildJavaRole != NULL) {

            jobject jkey = JNFGetObjectField(env, jchildJavaRole, sjf_key);

            childJavaRole = JNFJavaToNSString(env, jkey);

            (*env)->DeleteLocalRef(env, jkey);

        }

        JavaComponentAccessibility *child = [self createWithParent:parent accessible:jchild role:childJavaRole index:childIndex withEnv:env withView:parent->fView];

        (*env)->DeleteLocalRef(env, jchild);

        (*env)->DeleteLocalRef(env, jchildJavaRole);

        [children addObject:child];

        childIndex++;

    }

    (*env)->DeleteLocalRef(env, jchildrenAndRoles);

    return children;

}

+ (JavaComponentAccessibility *)createWithAccessible:(jobject)jaccessible withEnv:(JNIEnv *)env withView:(NSView *)view

{

    JavaComponentAccessibility *ret = nil;

    jobject jcomponent = [(AWTView *)view awtComponent:env];

    jint index = JNFCallStaticIntMethod(env, sjm_getAccessibleIndexInParent, jaccessible, jcomponent);

    if (index >= 0) {

      NSString *javaRole = getJavaRole(env, jaccessible, jcomponent);

      ret = [self createWithAccessible:jaccessible role:javaRole index:index withEnv:env withView:view];

    }

    (*env)->DeleteLocalRef(env, jcomponent);

    return ret;

}

+ (JavaComponentAccessibility *) createWithAccessible:(jobject)jaccessible role:(NSString *)javaRole index:(jint)index withEnv:(JNIEnv *)env withView:(NSView *)view

{

    return [self createWithParent:nil accessible:jaccessible role:javaRole index:index withEnv:env withView:view];

}

+ (JavaComponentAccessibility *) createWithParent:(JavaComponentAccessibility *)parent accessible:(jobject)jaccessible role:(NSString *)javaRole index:(jint)index withEnv:(JNIEnv *)env withView:(NSView *)view

{

    // try to fetch the jCAX from Java, and return autoreleased

    jobject jCAX = [JavaComponentAccessibility getCAccessible:jaccessible withEnv:env];

    if (jCAX == NULL) return nil;

    JavaComponentAccessibility *value = (JavaComponentAccessibility *) jlong_to_ptr(JNFGetLongField(env, jCAX, jf_ptr));

    if (value != nil) {

        (*env)->DeleteLocalRef(env, jCAX);

        return [[value retain] autorelease];

    }

    // otherwise, create a new instance

    JavaComponentAccessibility *newChild = nil;

    if ([javaRole isEqualToString:@"pagetablist"]) {

        newChild = [TabGroupAccessibility alloc];

    } else if ([javaRole isEqualToString:@"table"]) {

        newChild = [TableAccessibility alloc];

    } else if ([javaRole isEqualToString:@"scrollpane"]) {

        newChild = [ScrollAreaAccessibility alloc];

    } else {

        NSString *nsRole = [sRoles objectForKey:javaRole];

        if ([nsRole isEqualToString:NSAccessibilityStaticTextRole] || [nsRole isEqualToString:NSAccessibilityTextAreaRole] || [nsRole isEqualToString:NSAccessibilityTextFieldRole]) {

            newChild = [JavaTextAccessibility alloc];

        } else {

            newChild = [JavaComponentAccessibility alloc];

        }

    }

    // must init freshly -alloc'd object

    [newChild initWithParent:parent withEnv:env withAccessible:jCAX withIndex:index withView:view withJavaRole:javaRole]; // must init new instance

    // If creating a JPopupMenu (not a combobox popup list) need to fire menuOpened.

    // This is the only way to know if the menu is opening; visible state change

    // can't be caught because the listeners are not set up in time.

    if ( [javaRole isEqualToString:@"popupmenu"] &&

         ![[parent javaRole] isEqualToString:@"combobox"] ) {

        [newChild postMenuOpened];

    }

    // must hard retain pointer poked into Java object

    [newChild retain];

    JNFSetLongField(env, jCAX, jf_ptr, ptr_to_jlong(newChild));

    (*env)->DeleteLocalRef(env, jCAX);

    // return autoreleased instance

    return [newChild autorelease];

}

- (NSArray *)initializeAttributeNamesWithEnv:(JNIEnv *)env

{

    static JNF_STATIC_MEMBER_CACHE(jm_getInitialAttributeStates, sjc_CAccessibility, "getInitialAttributeStates", "(Ljavax/accessibility/Accessible;Ljava/awt/Component;)[Z");

    NSMutableArray *attributeNames = [NSMutableArray arrayWithCapacity:20];

    [attributeNames retain];

    // all elements respond to parent, role, role description, window, topLevelUIElement, help

    [attributeNames addObject:NSAccessibilityParentAttribute];

    [attributeNames addObject:NSAccessibilityRoleAttribute];

    [attributeNames addObject:NSAccessibilityRoleDescriptionAttribute];

    [attributeNames addObject:NSAccessibilityHelpAttribute];

    // cmcnote: AXMenu usually doesn't respond to window / topLevelUIElement. But menus within a Java app's window

    // probably should. Should we use some role other than AXMenu / AXMenuBar for Java menus?

    [attributeNames addObject:NSAccessibilityWindowAttribute];

    [attributeNames addObject:NSAccessibilityTopLevelUIElementAttribute];

    // set accessible subrole

    NSString *javaRole = [self javaRole];

    if (javaRole != nil && [javaRole isEqualToString:@"passwordtext"]) {

        //cmcnote: should turn this into a constant

        [attributeNames addObject:NSAccessibilitySubroleAttribute];

    }

    // Get all the other accessibility attributes states we need in one swell foop.

    // javaRole isn't pulled in because we need protected access to AccessibleRole.key

    jbooleanArray attributeStates = (jbooleanArray)JNFCallStaticObjectMethod(env, jm_getInitialAttributeStates, fAccessible, fComponent); // AWT_THREADING Safe (AWTRunLoop)

    if (attributeStates == NULL) return nil;

    jboolean *attributeStatesArray = (*env)->GetBooleanArrayElements(env, attributeStates, 0);

    if (attributeStatesArray == NULL) {

        // Note: Java will not be on the stack here so a java exception can't happen and no need to call ExceptionCheck.

        NSLog(@"%s failed calling GetBooleanArrayElements", __FUNCTION__);

        return nil;

    }

    // if there's a component, it can be enabled and it has a size/position

    if (attributeStatesArray[0]) {

        [attributeNames addObject:NSAccessibilityEnabledAttribute];

        [attributeNames addObject:NSAccessibilitySizeAttribute];

        [attributeNames addObject:NSAccessibilityPositionAttribute];

    }

    // According to javadoc, a component that is focusable will return true from isFocusTraversable,

    // as well as having AccessibleState.FOCUSABLE in it's AccessibleStateSet.

    // We use the former heuristic; if the component focus-traversable, add a focused attribute

    // See also: accessibilityIsFocusedAttributeSettable

    if (attributeStatesArray[1])

    {

        [attributeNames addObject:NSAccessibilityFocusedAttribute];

    }

    // if it's a pagetab / radiobutton, it has a value but no min/max value.

    // if it is a slider, supplying only the value makes it to voice out the value instead of percentages

    BOOL hasAxValue = attributeStatesArray[2];

    if ([javaRole isEqualToString:@"pagetab"] || [javaRole isEqualToString:@"radiobutton"] || [javaRole isEqualToString:@"slider"]) {

        [attributeNames addObject:NSAccessibilityValueAttribute];

    } else {

        // if not a pagetab/radio button, and it has a value, it has a min/max/current value.

        if (hasAxValue) {

            // er, it has a min/max/current value if it's not a button.

            // See AppKit/NSButtonCellAccessibility.m

            if (![javaRole isEqualToString:@"pushbutton"]) {

                //cmcnote: make this (and "passwordtext") constants instead of magic strings

                [attributeNames addObject:NSAccessibilityMinValueAttribute];

                [attributeNames addObject:NSAccessibilityMaxValueAttribute];

                [attributeNames addObject:NSAccessibilityValueAttribute];

            }

        }

    }

    // does it have an orientation?

    if (attributeStatesArray[4]) {

        [attributeNames addObject:NSAccessibilityOrientationAttribute];

    }

    // name

    if (attributeStatesArray[5]) {

        [attributeNames addObject:NSAccessibilityTitleAttribute];

    }

    // children

    if (attributeStatesArray[6]) {

        [attributeNames addObject:NSAccessibilityChildrenAttribute];

        if ([javaRole isEqualToString:@"list"]

                || [javaRole isEqualToString:@"table"]

                || [javaRole isEqualToString:@"pagetablist"]) {

            [attributeNames addObject:NSAccessibilitySelectedChildrenAttribute];

            [attributeNames addObject:NSAccessibilityVisibleChildrenAttribute];

        }

        // Just above, the below mentioned support has been added back in for lists.

        // However, the following comments may still be useful for future fixes.

//        [attributeNames addObject:NSAccessibilitySelectedChildrenAttribute];

//        [attributeNames addObject:NSAccessibilityVisibleChildrenAttribute];

                //According to AXRoles.txt:

                //VisibleChildren: radio group, list, row, table row subrole