CoreFoundationTest.java

/*
 * Copyright (c) 2019 Daniel Widdis
 *
 * The contents of this file is dual-licensed under 2
 * alternative Open Source/Free licenses: LGPL 2.1 or later and
 * Apache License 2.0. (starting with JNA version 4.0.0).
 *
 * You can freely decide which license you want to apply to
 * the project.
 *
 * You may obtain a copy of the LGPL License at:
 *
 * http://www.gnu.org/licenses/licenses.html
 *
 * A copy is also included in the downloadable source code package
 * containing JNA, in file "LGPL2.1".
 *
 * You may obtain a copy of the Apache License at:
 *
 * http://www.apache.org/licenses/
 *
 * A copy is also included in the downloadable source code package
 * containing JNA, in file "AL2.0".
 */
package com.sun.jna.platform.mac;

import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.io.UnsupportedEncodingException;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.List;
import java.util.Random;

import com.sun.jna.platform.mac.CoreFoundation.CFDictionaryRef;
import org.junit.Assert;
import org.junit.Test;

import com.sun.jna.Memory;
import com.sun.jna.Native;
import com.sun.jna.Pointer;
import com.sun.jna.platform.mac.CoreFoundation.CFAllocatorRef;
import com.sun.jna.platform.mac.CoreFoundation.CFArrayRef;
import com.sun.jna.platform.mac.CoreFoundation.CFDataRef;
import com.sun.jna.platform.mac.CoreFoundation.CFIndex;
import com.sun.jna.platform.mac.CoreFoundation.CFMutableDictionaryRef;
import com.sun.jna.platform.mac.CoreFoundation.CFNumberRef;
import com.sun.jna.platform.mac.CoreFoundation.CFNumberType;
import com.sun.jna.platform.mac.CoreFoundation.CFStringRef;
import com.sun.jna.platform.mac.CoreFoundation.CFTypeRef;
import com.sun.jna.ptr.DoubleByReference;
import com.sun.jna.ptr.IntByReference;
import com.sun.jna.ptr.LongByReference;
import com.sun.jna.ptr.PointerByReference;

public class CoreFoundationTest {

    private static final CoreFoundation CF = CoreFoundation.INSTANCE;

    @Test
    public void testCFStringRef() throws UnsupportedEncodingException {
        // Generate strings with different UTF8 byte lengths
        byte[] pound = { (byte) 0xc2, (byte) 0xa3 };
        byte[] euro = { (byte) 0xe2, (byte) 0x82, (byte) 0xac };
        byte[] smileEmoji = { (byte) 0xf0, (byte) 0x9f, (byte) 0x98, (byte) 0x83 };
        String[] testStrings = new String[4];
        testStrings[0] = "ascii";
        testStrings[1] = new String(pound, StandardCharsets.UTF_8);
        testStrings[2] = new String(euro, StandardCharsets.UTF_8);
        testStrings[3] = new String(smileEmoji, StandardCharsets.UTF_8);
        for (String utf8Str : testStrings) {
            CFStringRef cfStr = CFStringRef.createCFString(utf8Str);
            // Length matches length of char array
            // 2 for code points > 0xffff, 1 otherwise
            assertEquals(utf8Str.length(), CF.CFStringGetLength(cfStr).intValue());
            assertEquals(utf8Str, cfStr.stringValue());
            assertEquals(CoreFoundation.STRING_TYPE_ID, cfStr.getTypeID());

            byte[] utf8Arr = utf8Str.getBytes("UTF-8");
            Memory mem = new Memory(utf8Arr.length + 1);
            mem.clear();
            assertNotEquals(0,
                    CF.CFStringGetCString(cfStr, mem, new CFIndex(mem.size()), CoreFoundation.kCFStringEncodingUTF8));
            byte[] utf8Bytes = mem.getByteArray(0, (int) mem.size() - 1);
            assertArrayEquals(utf8Arr, utf8Bytes);
            // Essentially a toString, can't rely on format but should contain the string
            CFStringRef desc = CF.CFCopyDescription(cfStr);
            assertTrue(desc.stringValue().contains(utf8Str));

            desc.release();
            cfStr.release();
        }

        CFStringRef cfEmpty = CFStringRef.createCFString("");
        assertTrue(cfEmpty.stringValue().equals(""));
        cfEmpty.release();
    }

    @Test
    public void testCFNumberRef() {
        LongByReference max = new LongByReference(Long.MAX_VALUE);
        CFNumberRef cfMax = CF.CFNumberCreate(null, CFNumberType.kCFNumberLongLongType.typeIndex(), max);
        assertEquals(Long.MAX_VALUE, cfMax.longValue());
        assertEquals(CoreFoundation.NUMBER_TYPE_ID, cfMax.getTypeID());
        cfMax.release();

        IntByReference zero = new IntByReference(0);
        IntByReference one = new IntByReference(1);
        CFNumberRef cfZero = CF.CFNumberCreate(null, CFNumberType.kCFNumberIntType.typeIndex(), zero);
        CFNumberRef cfOne = CF.CFNumberCreate(null, CFNumberType.kCFNumberIntType.typeIndex(), one);

        assertEquals(0, cfZero.intValue());
        assertEquals(1, cfOne.intValue());
        cfZero.release();
        cfOne.release();
    }

    @Test
    public void testCFRetainCount() {
        DoubleByReference pi = new DoubleByReference(Math.PI);
        DoubleByReference e = new DoubleByReference(Math.E);
        CFNumberRef cfE = CF.CFNumberCreate(null, CFNumberType.kCFNumberDoubleType.typeIndex(), e);
        CFNumberRef cfPi = CF.CFNumberCreate(null, CFNumberType.kCFNumberDoubleType.typeIndex(), pi);
        assertEquals(1, CF.CFGetRetainCount(cfE).intValue());
        assertEquals(1, CF.CFGetRetainCount(cfPi).intValue());
        cfE.retain();
        cfPi.retain();
        cfPi.retain();
        assertEquals(2, CF.CFGetRetainCount(cfE).intValue());
        assertEquals(3, CF.CFGetRetainCount(cfPi).intValue());

        List<? extends CFTypeRef> irrationalReferences = Arrays.asList(cfE, cfPi);
        for (CFTypeRef value : irrationalReferences) {
            value.release();
        }

        assertEquals(1, CF.CFGetRetainCount(cfE).intValue());
        assertEquals(2, CF.CFGetRetainCount(cfPi).intValue());
        cfPi.release();
        assertEquals(1, CF.CFGetRetainCount(cfPi).intValue());
        cfE.release();
        cfPi.release();
    }

    @Test
    public void testCFArray() {
        CFNumberRef[] refArray = new CFNumberRef[3];
        int size = Native.getNativeSize(CFNumberRef.class);
        Memory contiguousArray = new Memory(size * refArray.length);
        for (int i = 0; i < refArray.length; i++) {
            refArray[i] = CF.CFNumberCreate(null, CoreFoundation.CFNumberType.kCFNumberIntType.typeIndex(),
                    new IntByReference(i));
            contiguousArray.setPointer(i * size, refArray[i].getPointer());
        }
        CFArrayRef cfPtrArray = CF.CFArrayCreate(null, contiguousArray, new CFIndex(refArray.length), null);
        assertEquals(CoreFoundation.ARRAY_TYPE_ID, cfPtrArray.getTypeID());

        assertEquals(refArray.length, cfPtrArray.getCount());
        for (int i = 0; i < refArray.length; i++) {
            Pointer result = cfPtrArray.getValueAtIndex(i);
            try {
                new CFStringRef(result);
                fail("Should have thrown a ClassCastExcpetion.");
            } catch (ClassCastException expected) {
                assertEquals("Unable to cast to CFString. Type ID: CFNumber", expected.getMessage());
            }
            CFNumberRef numRef = new CFNumberRef(result);
            assertEquals(i, numRef.intValue());
        }

        for (int i = 0; i < refArray.length; i++) {
            refArray[i].release();
        }
        cfPtrArray.release();
    }

    @Test
    public void testCFData() {
        int size = 128;
        // Create some random bytes
        byte[] randomBytes = new byte[size];
        new Random().nextBytes(randomBytes);
        // Fill native memory with them
        Memory nativeBytes = new Memory(size);
        nativeBytes.write(0, randomBytes, 0, randomBytes.length);
        // Create a CF reference to the data
        CFDataRef cfData = CF.CFDataCreate(null, nativeBytes, new CFIndex(size));
        assertEquals(CoreFoundation.DATA_TYPE_ID, cfData.getTypeID());

        int dataSize = cfData.getLength();
        assertEquals(size, dataSize);
        // Read it back out and convert to an array
        Pointer bytes = cfData.getBytePtr();
        byte[] dataBytes = bytes.getByteArray(0, dataSize);
        assertArrayEquals(randomBytes, dataBytes);
        cfData.release();
    }

    @Test
    public void testCFDictionary() {
        CFAllocatorRef alloc = CF.CFAllocatorGetDefault();
        CFMutableDictionaryRef dict = CF.CFDictionaryCreateMutable(alloc, new CFIndex(2), null, null);
        assertEquals(CoreFoundation.DICTIONARY_TYPE_ID, dict.getTypeID());

        CFStringRef oneStr = CFStringRef.createCFString("one");

        // Key does not exist, returns null
        assertEquals(0L, dict.getCount());
        assertFalse(dict.getValueIfPresent(oneStr, null));
        Pointer cfNull = dict.getValue(oneStr);
        assertNull(cfNull);

        // Store and retrieve null value
        dict.setValue(oneStr, null);
        assertTrue(dict.getValueIfPresent(oneStr, null));
        Pointer cfNullValue = dict.getValue(oneStr);
        assertNull(cfNullValue);

        // Store (replace the null) and retrieve integer value
        IntByReference one = new IntByReference(1);
        CFNumberRef cfOne = CF.CFNumberCreate(null, CFNumberType.kCFNumberIntType.typeIndex(), one);
        dict.setValue(oneStr, cfOne);
        assertEquals(1L, dict.getCount());

        assertTrue(dict.getValueIfPresent(oneStr, null));
        Pointer result = dict.getValue(oneStr);
        CFNumberRef numRef = new CFNumberRef(result);
        assertEquals(1, numRef.intValue());

        PointerByReference resultPtr = new PointerByReference();
        assertTrue(dict.getValueIfPresent(oneStr, resultPtr));
        numRef = new CFNumberRef(resultPtr.getValue());
        assertEquals(1, numRef.intValue());

        // Test non-CF type as key
        IntByReference onePtr = new IntByReference(1);
        dict.setValue(onePtr, oneStr);
        result = dict.getValue(onePtr);
        CFStringRef strRef = new CFStringRef(result);
        assertEquals("one", strRef.stringValue());
        assertEquals(2L, dict.getCount());

        oneStr.release();
        cfOne.release();
        dict.release();
    }

    @Test
    public void testCFStringRefByReference() {
        CFStringRef key = CFStringRef.createCFString("key");
        CFStringRef value = CFStringRef.createCFString("value");

        CFMutableDictionaryRef dict = CF.CFDictionaryCreateMutable(null, new CFIndex(2), null, null);
        dict.setValue(key, value);

        // test getStringRefValue()
        CFStringRef.ByReference byRef = new CFStringRef.ByReference();
        assertTrue(dict.getValueIfPresent(key, byRef));
        assertTrue(CF.CFEqual(value, byRef.getStringRefValue()));

        // test constructor()
        assertNull(new CFStringRef.ByReference().getValue());

        // test constructor(null)
        assertNull(new CFStringRef.ByReference(null).getValue());

        // test setValue(null)
        assertNotNull(byRef.getStringRefValue());
        byRef.setValue(null);
        assertNull(byRef.getStringRefValue());

        // test setValue(CFStringRef), getValue()
        byRef.setValue(value.getPointer());
        assertTrue(CF.CFEqual(value, byRef.getStringRefValue()));
        assertEquals(value.getPointer(), byRef.getValue());

        // test setValue(CFDictionaryRef)
        try {
            byRef.setValue(dict.getPointer());
            Assert.fail("must fail");
        } catch (ClassCastException cce) {
            // as it should be
        }

        CF.CFRelease(key);
        CF.CFRelease(value);
        CF.CFRelease(dict);
    }

    @Test
    public void testCFDictionaryRefByReference() {
        CFStringRef key = CFStringRef.createCFString("key");

        CFMutableDictionaryRef value = CF.CFDictionaryCreateMutable(null, new CFIndex(2), null, null);
        value.setValue(key, key);

        CFMutableDictionaryRef dict = CF.CFDictionaryCreateMutable(null, new CFIndex(2), null, null);
        dict.setValue(key, value);

        // test getDictionaryRefValue()
        CFDictionaryRef.ByReference byRef = new CFDictionaryRef.ByReference();
        assertTrue(dict.getValueIfPresent(key, byRef));
        assertTrue(CF.CFEqual(value, byRef.getDictionaryRefValue()));

        // test constructor()
        assertNull(new CFDictionaryRef.ByReference().getValue());

        // test constructor(null)
        assertNull(new CFDictionaryRef.ByReference(null).getValue());

        // test setValue(null)
        assertNotNull(byRef.getDictionaryRefValue());
        byRef.setValue(null);
        assertNull(byRef.getDictionaryRefValue());

        // test setValue(CFDictionaryRef), getValue()
        byRef.setValue(value.getPointer());
        assertTrue(CF.CFEqual(value, byRef.getDictionaryRefValue()));
        assertEquals(value.getPointer(), byRef.getValue());

        // test setValue(CFStringRef)
        try {
            byRef.setValue(key.getPointer());
            Assert.fail("must fail");
        } catch (ClassCastException cce) {
            // as it should be
        }

        CF.CFRelease(key);
        CF.CFRelease(value);
        CF.CFRelease(dict);
    }

    @Test
    public void testCFGetTypeID() {
        CFStringRef s1 = CFStringRef.createCFString("s1");
        assertEquals(CF.CFStringGetTypeID(), CF.CFGetTypeID(s1.getPointer()));
        assertEquals(CF.CFStringGetTypeID(), CF.CFGetTypeID(s1));
        s1.release();
    }

    @Test
    public void testCFEqual() {
        CFStringRef s1 = CFStringRef.createCFString("s1");
        CFStringRef s1_the_same = CFStringRef.createCFString("s1");
        CFStringRef s2 = CFStringRef.createCFString("s2");

        assertTrue(CF.CFEqual(s1, s1));
        assertTrue(CF.CFEqual(s1, s1_the_same));

        assertFalse(CF.CFEqual(s1, s2));

        CFMutableDictionaryRef dict1 = CF.CFDictionaryCreateMutable(null, new CFIndex(2), null, null);
        dict1.setValue(s1, s1);
        CFMutableDictionaryRef dict2 = CF.CFDictionaryCreateMutable(null, new CFIndex(2), null, null);
        dict2.setValue(s1, s1);

        assertNotEquals(dict1.getPointer(), dict2.getPointer());
        assertTrue(CF.CFEqual(dict1, dict2));

        dict2.setValue(s1, s2);
        assertFalse(CF.CFEqual(dict1, dict2));

        CF.CFRelease(dict1);
        CF.CFRelease(dict2);
        CF.CFRelease(s1);
        CF.CFRelease(s1_the_same);
        CF.CFRelease(s2);
    }
}