axmol/core/platform/mac/Device-mac.mm

/****************************************************************************
Copyright (c) 2010-2012 cocos2d-x.org
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
Copyright (c) 2021-2023 Bytedance Inc.

https://axmolengine.github.io/

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#include "platform/Device.h"
#include <Foundation/Foundation.h>
#include <Cocoa/Cocoa.h>
#include <string>
#include "base/Types.h"
#include "platform/apple/Device-apple.h"

NS_AX_BEGIN

static NSAttributedString* __attributedStringWithFontSize(NSMutableAttributedString* attributedString, CGFloat fontSize)
{
    {
        [attributedString beginEditing];

        [attributedString enumerateAttribute:NSFontAttributeName
                                     inRange:NSMakeRange(0, attributedString.length)
                                     options:0
                                  usingBlock:^(id value, NSRange range, BOOL* stop) {
                                    NSFont* font = value;
                                    font         = [[NSFontManager sharedFontManager] convertFont:font toSize:fontSize];

                                    [attributedString removeAttribute:NSFontAttributeName range:range];
                                    [attributedString addAttribute:NSFontAttributeName value:font range:range];
                                  }];

        [attributedString endEditing];
    }

    return [[attributedString copy] autorelease];
}

int Device::getDPI()
{
    NSScreen* screen           = [NSScreen mainScreen];
    NSDictionary* description  = [screen deviceDescription];
    NSSize displayPixelSize    = [[description objectForKey:NSDeviceSize] sizeValue];
    CGSize displayPhysicalSize = CGDisplayScreenSize([[description objectForKey:@"NSScreenNumber"] unsignedIntValue]);

    return ((displayPixelSize.width / displayPhysicalSize.width) * 25.4f);
}

float Device::getPixelRatio() 
{
    return Device::getDPI() / 25.4f;
}

void Device::setAccelerometerEnabled(bool isEnabled) {}

void Device::setAccelerometerInterval(float interval) {}

typedef struct
{
    int height;
    int width;
    bool hasAlpha;
    bool isPremultipliedAlpha;
    unsigned char* data;
} tImageInfo;

static NSSize _calculateStringSize(NSAttributedString* str,
                                   id font,
                                   CGSize* constrainSize,
                                   bool enableWrap,
                                   int overflow)
{
    NSSize textRect = NSZeroSize;
    textRect.width  = constrainSize->width > 0 ? constrainSize->width : CGFLOAT_MAX;
    textRect.height = constrainSize->height > 0 ? constrainSize->height : CGFLOAT_MAX;

    if (overflow == 1)
    {
        if (!enableWrap)
        {
            textRect.width  = CGFLOAT_MAX;
            textRect.height = CGFLOAT_MAX;
        }
        else
        {
            textRect.height = CGFLOAT_MAX;
        }
    }

    NSSize dim;
#ifdef __MAC_10_11
#    if __MAC_OS_X_VERSION_MAX_ALLOWED >= __MAC_10_11
    dim = [str boundingRectWithSize:textRect
                            options:(NSStringDrawingOptions)(NSStringDrawingUsesLineFragmentOrigin)context:nil]
              .size;
#    else
    dim = [str boundingRectWithSize:textRect options:(NSStringDrawingOptions)(NSStringDrawingUsesLineFragmentOrigin)]
              .size;
#    endif
#else
    dim = [str boundingRectWithSize:textRect options:(NSStringDrawingOptions)(NSStringDrawingUsesLineFragmentOrigin)]
              .size;
#endif

    dim.width  = ceilf(dim.width);
    dim.height = ceilf(dim.height);

    return dim;
}

static NSSize _calculateRealSizeForString(NSAttributedString** str, id font, NSSize constrainSize, bool enableWrap)
{
    CGRect actualSize = CGRectMake(0, 0, constrainSize.width + 1, constrainSize.height + 1);
    int fontSize      = [font pointSize];
    fontSize          = fontSize + 1;

    if (!enableWrap)
    {
        while (actualSize.size.width > constrainSize.width || actualSize.size.height > constrainSize.height)
        {
            fontSize = fontSize - 1;
            if (fontSize < 0)
            {
                actualSize = CGRectMake(0, 0, 0, 0);
                break;
            }

            NSMutableAttributedString* mutableString = [[*str mutableCopy] autorelease];
            *str                                     = __attributedStringWithFontSize(mutableString, fontSize);

#ifdef __MAC_10_11
#    if __MAC_OS_X_VERSION_MAX_ALLOWED >= __MAC_10_11
            CGSize fitSize = [*str boundingRectWithSize:CGSizeMake(CGFLOAT_MAX, CGFLOAT_MAX)
                                                options:NSStringDrawingUsesLineFragmentOrigin
                                                context:nil]
                                 .size;
#    else
            CGSize fitSize = [*str boundingRectWithSize:CGSizeMake(CGFLOAT_MAX, CGFLOAT_MAX)
                                                options:NSStringDrawingUsesLineFragmentOrigin]
                                 .size;
#    endif
#else
            CGSize fitSize = [*str boundingRectWithSize:CGSizeMake(CGFLOAT_MAX, CGFLOAT_MAX)
                                                options:NSStringDrawingUsesLineFragmentOrigin]
                                 .size;
#endif

            if (fitSize.width == 0 || fitSize.height == 0)
                continue;
            actualSize.size = fitSize;

            if (constrainSize.width <= 0)
            {
                constrainSize.width = fitSize.width;
            }
            if (constrainSize.height <= 0)
            {
                constrainSize.height = fitSize.height;
            }
            if (fontSize <= 0)
            {
                break;
            }
        }
    }
    else
    {
        while (actualSize.size.height > constrainSize.height || actualSize.size.width > constrainSize.width)
        {
            fontSize = fontSize - 1;
            if (fontSize < 0)
            {
                actualSize = CGRectMake(0, 0, 0, 0);
                break;
            }

            NSMutableAttributedString* mutableString = [[*str mutableCopy] autorelease];
            *str                                     = __attributedStringWithFontSize(mutableString, fontSize);

#ifdef __MAC_10_11
#    if __MAC_OS_X_VERSION_MAX_ALLOWED >= __MAC_10_11
            CGSize fitSize = [*str boundingRectWithSize:CGSizeMake(constrainSize.width, CGFLOAT_MAX)
                                                options:NSStringDrawingUsesLineFragmentOrigin
                                                context:nil]
                                 .size;
#    else
            CGSize fitSize = [*str boundingRectWithSize:CGSizeMake(constrainSize.width, CGFLOAT_MAX)
                                                options:NSStringDrawingUsesLineFragmentOrigin]
                                 .size;
#    endif
#else
            CGSize fitSize = [*str boundingRectWithSize:CGSizeMake(constrainSize.width, CGFLOAT_MAX)
                                                options:NSStringDrawingUsesLineFragmentOrigin]
                                 .size;
#endif

            if (fitSize.width == 0 || fitSize.height == 0)
                continue;
            actualSize.size = fitSize;

            if (constrainSize.width <= 0)
            {
                constrainSize.width = fitSize.width;
            }
            if (constrainSize.height <= 0)
            {
                constrainSize.height = fitSize.height;
            }
            if (fontSize <= 0)
            {
                break;
            }
        }
    }
    return CGSizeMake(actualSize.size.width, actualSize.size.height);
}

static NSFont* _createSystemFont(const char* fontName, int size)
{
    NSString* fntName = [NSString stringWithUTF8String:fontName];
    fntName           = [[fntName lastPathComponent] stringByDeletingPathExtension];

    // font
    NSFont* font = [NSFont fontWithName:fntName size:size];

    if (font == nil)
    {
        font = [NSFont systemFontOfSize:size];
    }
    return font;
}

static CGFloat _calculateTextDrawStartHeight(ax::Device::TextAlign align, CGSize realDimensions, CGSize dimensions)
{
    float startH = 0;
    // vertical alignment
    unsigned int vAlignment = ((int)align >> 4) & 0x0F;
    switch (vAlignment)
    {
        // bottom
    case 1:
        startH = dimensions.height - realDimensions.height;
        break;
        // top
    case 2:
        startH = 0;
        break;
        // center
    case 3:
        startH = (dimensions.height - realDimensions.height) / 2;
        break;
    default:
        break;
    }
    return startH;
}

static bool _initWithString(std::string_view text,
                            Device::TextAlign align,
                            const char* fontName,
                            int size,
                            tImageInfo* info,
                            const Color3B* fontColor,
                            int fontAlpha,
                            bool enableWrap,
                            int overflow,
                            const FontStroke& stroke)
{
    bool ret = false;

    AXASSERT(!text.empty(), "Invalid text");
    AXASSERT(info, "Invalid info");

    do
    {
        NSString* string = [NSString stringWithUTF8String:text.data()];
        AX_BREAK_IF(!string);

        id font = _createSystemFont(fontName, size);
        AX_BREAK_IF(!font);

        // color
        NSColor* foregroundColor;
        if (fontColor)
        {
            foregroundColor = [NSColor colorWithDeviceRed:fontColor->r / 255.0
                                                    green:fontColor->g / 255.0
                                                     blue:fontColor->b / 255.0
                                                    alpha:fontAlpha / 255.0];
        }
        else
        {
            foregroundColor = [NSColor whiteColor];
        }

        // alignment
        NSTextAlignment textAlign               = FontUtils::_calculateTextAlignment(align);
        NSMutableParagraphStyle* paragraphStyle = FontUtils::_calculateParagraphStyle(enableWrap, overflow);
        [paragraphStyle setAlignment:textAlign];

        // attribute
        NSDictionary* tokenAttributesDict = [NSDictionary
            dictionaryWithObjectsAndKeys:foregroundColor, NSForegroundColorAttributeName, font, NSFontAttributeName,
                                         paragraphStyle, NSParagraphStyleAttributeName, nil];
        NSAttributedString* stringWithAttributes =
            [[[NSAttributedString alloc] initWithString:string attributes:tokenAttributesDict] autorelease];

        CGSize dimensions = CGSizeMake(info->width, info->height);

        NSSize realDimensions;

        if (overflow == 2)
            realDimensions = _calculateRealSizeForString(&stringWithAttributes, font, dimensions, enableWrap);
        else
            realDimensions = _calculateStringSize(stringWithAttributes, font, &dimensions, enableWrap, overflow);

        // Mac crashes if the width or height is 0
        AX_BREAK_IF(realDimensions.width <= 0 || realDimensions.height <= 0);

        if (dimensions.width <= 0.f)
            dimensions.width = realDimensions.width;
        if (dimensions.height <= 0.f)
            dimensions.height = realDimensions.height;

        // Alignment
        CGFloat xPadding = FontUtils::_calculateTextDrawStartWidth(align, realDimensions, dimensions);

        CGFloat yPadding = _calculateTextDrawStartHeight(align, realDimensions, dimensions);

        NSInteger POTWide = dimensions.width;
        NSInteger POTHigh = dimensions.height;
        NSRect textRect =
            NSMakeRect(xPadding, POTHigh - dimensions.height + yPadding, realDimensions.width, realDimensions.height);

        NSBitmapImageRep* offscreenRep = [[[NSBitmapImageRep alloc] initWithBitmapDataPlanes:NULL
                                                                                  pixelsWide:POTWide
                                                                                  pixelsHigh:POTHigh
                                                                               bitsPerSample:8
                                                                             samplesPerPixel:4
                                                                                    hasAlpha:YES
                                                                                    isPlanar:NO
                                                                              colorSpaceName:NSDeviceRGBColorSpace
                                                                                bitmapFormat:0
                                                                                 bytesPerRow:4 * POTWide
                                                                                bitsPerPixel:32] autorelease];

        NSGraphicsContext* g = [NSGraphicsContext graphicsContextWithBitmapImageRep:offscreenRep];
        [NSGraphicsContext saveGraphicsState];
        [NSGraphicsContext setCurrentContext:g];

        if (stroke._strokeSize > 0)
        {
            NSColor* strokeColor               = [NSColor colorWithDeviceRed:stroke._strokeColor.r / 255.0
                                                         green:stroke._strokeColor.g / 255.0
                                                          blue:stroke._strokeColor.b / 255.0
                                                         alpha:stroke._strokeAlpha / 255.0];
            NSNumber* strokeSize               = [NSNumber numberWithFloat:stroke._strokeSize / size * 100.0];
            NSDictionary* tokenAttributesDict2 = [NSDictionary
                dictionaryWithObjectsAndKeys:foregroundColor, NSForegroundColorAttributeName, font, NSFontAttributeName,
                                             paragraphStyle, NSParagraphStyleAttributeName, strokeSize,
                                             NSStrokeWidthAttributeName, strokeColor, NSStrokeColorAttributeName, nil];
            NSAttributedString* strokeString =
                [[[NSAttributedString alloc] initWithString:string attributes:tokenAttributesDict2] autorelease];
            [strokeString drawInRect:textRect];
        }

        [stringWithAttributes drawInRect:textRect];
        [NSGraphicsContext restoreGraphicsState];

        auto data = (unsigned char*)[offscreenRep bitmapData];  // Use the same buffer to improve the performance.

        NSUInteger textureSize = POTWide * POTHigh * 4;
        auto dataNew           = (unsigned char*)malloc(sizeof(unsigned char) * textureSize);
        if (dataNew)
        {
            memcpy(dataNew, data, textureSize);
            // output params
            info->width                = static_cast<int>(POTWide);
            info->height               = static_cast<int>(POTHigh);
            info->data                 = dataNew;
            info->hasAlpha             = true;
            info->isPremultipliedAlpha = true;
            ret                        = true;
        }
    } while (0);
    return ret;
}

Data Device::getTextureDataForText(std::string_view text,
                                   const FontDefinition& textDefinition,
                                   TextAlign align,
                                   int& width,
                                   int& height,
                                   bool& hasPremultipliedAlpha)
{
    Data ret;
    do
    {
        tImageInfo info = {0};
        info.width      = textDefinition._dimensions.width;
        info.height     = textDefinition._dimensions.height;

        if (!_initWithString(text, align, textDefinition._fontName.c_str(), textDefinition._fontSize, &info,
                             &textDefinition._fontFillColor, textDefinition._fontAlpha, textDefinition._enableWrap,
                             textDefinition._overflow, textDefinition._stroke))
        {
            break;
        }
        height = (short)info.height;
        width  = (short)info.width;
        ret.fastSet(info.data, width * height * 4);
        hasPremultipliedAlpha = true;
    } while (0);

    return ret;
}

void Device::setKeepScreenOn(bool value) {}

void Device::vibrate(float duration) {}

void Device::prepareImpactFeedbackGenerator(ImpactFeedbackStyle style) {}

void Device::impactOccurred(ImpactFeedbackStyle style) {}

void Device::prepareNotificationFeedbackGenerator() {}

void Device::notificationOccurred(NotificationFeedbackType type) {}

void Device::prepareSelectionFeedbackGenerator() {}

void Device::selectionChanged() {}

NS_AX_END