FlutterStandardCodecHelper.h File Reference

#include <CoreFoundation/CoreFoundation.h>
#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Enumerations
enum	FlutterStandardField {   FlutterStandardFieldNil , FlutterStandardFieldTrue , FlutterStandardFieldFalse , FlutterStandardFieldInt32 ,   FlutterStandardFieldInt64 , FlutterStandardFieldIntHex , FlutterStandardFieldFloat64 , FlutterStandardFieldString ,   FlutterStandardFieldUInt8Data , FlutterStandardFieldInt32Data , FlutterStandardFieldInt64Data , FlutterStandardFieldFloat64Data ,   FlutterStandardFieldList , FlutterStandardFieldMap , FlutterStandardFieldFloat32Data }
enum	FlutterStandardCodecObjcType {   FlutterStandardCodecObjcTypeNil , FlutterStandardCodecObjcTypeNSNumber , FlutterStandardCodecObjcTypeNSString , FlutterStandardCodecObjcTypeFlutterStandardTypedData ,   FlutterStandardCodecObjcTypeNSData , FlutterStandardCodecObjcTypeNSArray , FlutterStandardCodecObjcTypeNSDictionary , FlutterStandardCodecObjcTypeUnknown }

Functions
static bool	FlutterStandardFieldIsStandardType (uint8_t field)
Reader Helpers
void	FlutterStandardCodecHelperReadAlignment (unsigned long *location, uint8_t alignment)
void	FlutterStandardCodecHelperReadBytes (unsigned long *location, unsigned long length, void *destination, CFDataRef data)
uint8_t	FlutterStandardCodecHelperReadByte (unsigned long *location, CFDataRef data)
uint32_t	FlutterStandardCodecHelperReadSize (unsigned long *location, CFDataRef data)
CFStringRef	FlutterStandardCodecHelperReadUTF8 (unsigned long *location, CFDataRef data)
CFTypeRef	FlutterStandardCodecHelperReadValueOfType (unsigned long *location, CFDataRef data, uint8_t type, CFTypeRef(*ReadValue)(CFTypeRef), CFTypeRef(*ReadTypedDataOfType)(FlutterStandardField, CFTypeRef), CFTypeRef user_data)
Writer Helpers
void	FlutterStandardCodecHelperWriteByte (CFMutableDataRef data, uint8_t value)
void	FlutterStandardCodecHelperWriteBytes (CFMutableDataRef data, const void *bytes, unsigned long length)
void	FlutterStandardCodecHelperWriteSize (CFMutableDataRef data, uint32_t size)
void	FlutterStandardCodecHelperWriteAlignment (CFMutableDataRef data, uint8_t alignment)
void	FlutterStandardCodecHelperWriteUTF8 (CFMutableDataRef data, CFStringRef value)
void	FlutterStandardCodecHelperWriteData (CFMutableDataRef data, CFDataRef value)
bool	FlutterStandardCodecHelperWriteNumber (CFMutableDataRef data, CFNumberRef number)

Enumeration Type Documentation

FlutterStandardCodecObjcType

enum FlutterStandardCodecObjcType

Enumerator
FlutterStandardCodecObjcTypeNil
FlutterStandardCodecObjcTypeNSNumber
FlutterStandardCodecObjcTypeNSString
FlutterStandardCodecObjcTypeFlutterStandardTypedData
FlutterStandardCodecObjcTypeNSData
FlutterStandardCodecObjcTypeNSArray
FlutterStandardCodecObjcTypeNSDictionary
FlutterStandardCodecObjcTypeUnknown

Definition at line 44 of file FlutterStandardCodecHelper.h.

             {
  // NOLINTBEGIN(readability-identifier-naming)
  FlutterStandardCodecObjcTypeNil,
  FlutterStandardCodecObjcTypeNSNumber,
  FlutterStandardCodecObjcTypeNSString,
  FlutterStandardCodecObjcTypeFlutterStandardTypedData,
  FlutterStandardCodecObjcTypeNSData,
  FlutterStandardCodecObjcTypeNSArray,
  FlutterStandardCodecObjcTypeNSDictionary,
  FlutterStandardCodecObjcTypeUnknown,
  // NOLINTEND(readability-identifier-naming)
} FlutterStandardCodecObjcType;

FlutterStandardField

enum FlutterStandardField

Enumerator
FlutterStandardFieldNil
FlutterStandardFieldTrue
FlutterStandardFieldFalse
FlutterStandardFieldInt32
FlutterStandardFieldInt64
FlutterStandardFieldIntHex
FlutterStandardFieldFloat64
FlutterStandardFieldString
FlutterStandardFieldUInt8Data
FlutterStandardFieldInt32Data
FlutterStandardFieldInt64Data
FlutterStandardFieldFloat64Data
FlutterStandardFieldList
FlutterStandardFieldMap
FlutterStandardFieldFloat32Data

Definition at line 19 of file FlutterStandardCodecHelper.h.

             {
  // NOLINTBEGIN(readability-identifier-naming)
  FlutterStandardFieldNil,
  FlutterStandardFieldTrue,
  FlutterStandardFieldFalse,
  FlutterStandardFieldInt32,
  FlutterStandardFieldInt64,
  FlutterStandardFieldIntHex,
  FlutterStandardFieldFloat64,
  FlutterStandardFieldString,
  FlutterStandardFieldUInt8Data,
  FlutterStandardFieldInt32Data,
  FlutterStandardFieldInt64Data,
  FlutterStandardFieldFloat64Data,
  FlutterStandardFieldList,
  FlutterStandardFieldMap,
  FlutterStandardFieldFloat32Data,
  // NOLINTEND(readability-identifier-naming)
} FlutterStandardField;

Function Documentation

FlutterStandardCodecHelperReadAlignment()

void FlutterStandardCodecHelperReadAlignment	(	unsigned long *	location,
		uint8_t	alignment
	)

Definition at line 18 of file FlutterStandardCodecHelper.cc.

                                                                {
  uint8_t mod = *location % alignment;
  if (mod) {
    *location += (alignment - mod);
  }
}

FlutterStandardCodecHelperReadByte()

uint8_t FlutterStandardCodecHelperReadByte	(	unsigned long *	location,
		CFDataRef	data
	)

Definition at line 42 of file FlutterStandardCodecHelper.cc.

                                                           {
  uint8_t value;
  FlutterStandardCodecHelperReadBytes(location, 1, &value, data);
  return value;
}

FlutterStandardCodecHelperReadBytes()

void FlutterStandardCodecHelperReadBytes	(	unsigned long *	location,
		unsigned long	length,
		void *	destination,
		CFDataRef	data
	)

Definition at line 33 of file FlutterStandardCodecHelper.cc.

                                                         {
  CFRange range = CFRangeMake(*location, length);
  CFDataGetBytes(data, range, static_cast<UInt8*>(destination));
  *location += length;
}

FlutterStandardCodecHelperReadSize()

uint32_t FlutterStandardCodecHelperReadSize	(	unsigned long *	location,
		CFDataRef	data
	)

Definition at line 49 of file FlutterStandardCodecHelper.cc.

                                                            {
  uint8_t byte = FlutterStandardCodecHelperReadByte(location, data);
  if (byte < 254) {
    return (uint32_t)byte;
  } else if (byte == 254) {
    UInt16 value;
    FlutterStandardCodecHelperReadBytes(location, 2, &value, data);
    return value;
  } else {
    UInt32 value;
    FlutterStandardCodecHelperReadBytes(location, 4, &value, data);
    return value;
  }
}

FlutterStandardCodecHelperReadUTF8()

CFStringRef FlutterStandardCodecHelperReadUTF8	(	unsigned long *	location,
		CFDataRef	data
	)

Definition at line 75 of file FlutterStandardCodecHelper.cc.

                                                               {
  uint32_t size = FlutterStandardCodecHelperReadSize(location, data);
  CFDataRef bytes = ReadDataNoCopy(location, size, data);
  CFStringRef result = CFStringCreateFromExternalRepresentation(
      kCFAllocatorDefault, bytes, kCFStringEncodingUTF8);
  return static_cast<CFStringRef>(CFAutorelease(result));
}

FlutterStandardCodecHelperReadValueOfType()

CFTypeRef FlutterStandardCodecHelperReadValueOfType	(	unsigned long *	location,
		CFDataRef	data,
		uint8_t	type,
		CFTypeRef(*)(CFTypeRef)	ReadValue,
		CFTypeRef(*)(FlutterStandardField, CFTypeRef)	ReadTypedDataOfType,
		CFTypeRef	user_data
	)

Definition at line 103 of file FlutterStandardCodecHelper.cc.

                         {
  FlutterStandardField field = (FlutterStandardField)type;
  switch (field) {
    case FlutterStandardFieldNil:
      return nil;
    case FlutterStandardFieldTrue:
      return kCFBooleanTrue;
    case FlutterStandardFieldFalse:
      return kCFBooleanFalse;
    case FlutterStandardFieldInt32: {
      int32_t value;
      FlutterStandardCodecHelperReadBytes(location, 4, &value, data);
      return CFAutorelease(
          CFNumberCreate(kCFAllocatorDefault, kCFNumberSInt32Type, &value));
    }
    case FlutterStandardFieldInt64: {
      int64_t value;
      FlutterStandardCodecHelperReadBytes(location, 8, &value, data);
      return CFAutorelease(
          CFNumberCreate(kCFAllocatorDefault, kCFNumberSInt64Type, &value));
    }
    case FlutterStandardFieldFloat64: {
      Float64 value;
      FlutterStandardCodecHelperReadAlignment(location, 8);
      FlutterStandardCodecHelperReadBytes(location, 8, &value, data);
      return CFAutorelease(
          CFNumberCreate(kCFAllocatorDefault, kCFNumberDoubleType, &value));
    }
    case FlutterStandardFieldIntHex:
    case FlutterStandardFieldString:
      return FlutterStandardCodecHelperReadUTF8(location, data);
    case FlutterStandardFieldUInt8Data:
    case FlutterStandardFieldInt32Data:
    case FlutterStandardFieldInt64Data:
    case FlutterStandardFieldFloat32Data:
    case FlutterStandardFieldFloat64Data:
      return ReadTypedDataOfType(field, user_data);
    case FlutterStandardFieldList: {
      UInt32 length = FlutterStandardCodecHelperReadSize(location, data);
      CFMutableArrayRef array = CFArrayCreateMutable(
          kCFAllocatorDefault, length, &kCFTypeArrayCallBacks);
      for (UInt32 i = 0; i < length; i++) {
        CFTypeRef value = FastReadValue(location, data, ReadValue,
                                        ReadTypedDataOfType, user_data);
        CFArrayAppendValue(array, (value == nil ? kCFNull : value));
      }
      return CFAutorelease(array);
    }
    case FlutterStandardFieldMap: {
      UInt32 size = FlutterStandardCodecHelperReadSize(location, data);
      CFMutableDictionaryRef dict = CFDictionaryCreateMutable(
          kCFAllocatorDefault, size, &kCFTypeDictionaryKeyCallBacks,
          &kCFTypeDictionaryValueCallBacks);
      for (UInt32 i = 0; i < size; i++) {
        CFTypeRef key = FastReadValue(location, data, ReadValue,
                                      ReadTypedDataOfType, user_data);
        CFTypeRef val = FastReadValue(location, data, ReadValue,
                                      ReadTypedDataOfType, user_data);
        CFDictionaryAddValue(dict, (key == nil ? kCFNull : key),
                             (val == nil ? kCFNull : val));
      }
      return CFAutorelease(dict);
    }
    default:
      // Malformed message.
      FML_DCHECK(false);
  }
}

FlutterStandardCodecHelperWriteAlignment()

void FlutterStandardCodecHelperWriteAlignment	(	CFMutableDataRef	data,
		uint8_t	alignment
	)

Definition at line 201 of file FlutterStandardCodecHelper.cc.

                                                                 {
  uint8_t mod = CFDataGetLength(data) % alignment;
  if (mod) {
    for (int i = 0; i < (alignment - mod); i++) {
      FlutterStandardCodecHelperWriteByte(data, 0);
    }
  }
}

FlutterStandardCodecHelperWriteByte()

void FlutterStandardCodecHelperWriteByte	(	CFMutableDataRef	data,
		uint8_t	value
	)

Definition at line 178 of file FlutterStandardCodecHelper.cc.

                                                                               {
  CFDataAppendBytes(data, &value, 1);
}

FlutterStandardCodecHelperWriteBytes()

void FlutterStandardCodecHelperWriteBytes	(	CFMutableDataRef	data,
		const void *	bytes,
		unsigned long	length
	)

Definition at line 182 of file FlutterStandardCodecHelper.cc.

                                                                {
  CFDataAppendBytes(data, static_cast<const UInt8*>(bytes), length);
}

FlutterStandardCodecHelperWriteData()

void FlutterStandardCodecHelperWriteData	(	CFMutableDataRef	data,
		CFDataRef	value
	)

Definition at line 232 of file FlutterStandardCodecHelper.cc.

                                                          {
  const UInt8* bytes = CFDataGetBytePtr(value);
  CFIndex length = CFDataGetLength(value);
  FlutterStandardCodecHelperWriteBytes(data, bytes, length);
}

FlutterStandardCodecHelperWriteNumber()

bool FlutterStandardCodecHelperWriteNumber	(	CFMutableDataRef	data,
		CFNumberRef	number
	)

Definition at line 239 of file FlutterStandardCodecHelper.cc.

                                                               {
  bool success = false;
  if (CFGetTypeID(number) == CFBooleanGetTypeID()) {
    bool b = CFBooleanGetValue((CFBooleanRef)number);
    FlutterStandardCodecHelperWriteByte(
        data, (b ? FlutterStandardFieldTrue : FlutterStandardFieldFalse));
    success = true;
  } else if (CFNumberIsFloatType(number)) {
    Float64 f;
    success = CFNumberGetValue(number, kCFNumberFloat64Type, &f);
    if (success) {
      FlutterStandardCodecHelperWriteByte(data, FlutterStandardFieldFloat64);
      FlutterStandardCodecHelperWriteAlignment(data, 8);
      FlutterStandardCodecHelperWriteBytes(data, &f, 8);
    }
  } else if (CFNumberGetByteSize(number) <= 4) {
    SInt32 n;
    success = CFNumberGetValue(number, kCFNumberSInt32Type, &n);
    if (success) {
      FlutterStandardCodecHelperWriteByte(data, FlutterStandardFieldInt32);
      FlutterStandardCodecHelperWriteBytes(data, &n, 4);
    }
  } else if (CFNumberGetByteSize(number) <= 8) {
    SInt64 n;
    success = CFNumberGetValue(number, kCFNumberSInt64Type, &n);
    if (success) {
      FlutterStandardCodecHelperWriteByte(data, FlutterStandardFieldInt64);
      FlutterStandardCodecHelperWriteBytes(data, &n, 8);
    }
  }
  return success;
}

FlutterStandardCodecHelperWriteSize()

void FlutterStandardCodecHelperWriteSize	(	CFMutableDataRef	data,
		uint32_t	size
	)

Definition at line 188 of file FlutterStandardCodecHelper.cc.

                                                                               {
  if (size < 254) {
    FlutterStandardCodecHelperWriteByte(data, size);
  } else if (size <= 0xffff) {
    FlutterStandardCodecHelperWriteByte(data, 254);
    UInt16 value = (UInt16)size;
    FlutterStandardCodecHelperWriteBytes(data, &value, 2);
  } else {
    FlutterStandardCodecHelperWriteByte(data, 255);
    FlutterStandardCodecHelperWriteBytes(data, &size, 4);
  }
}

FlutterStandardCodecHelperWriteUTF8()

void FlutterStandardCodecHelperWriteUTF8	(	CFMutableDataRef	data,
		CFStringRef	value
	)

Definition at line 211 of file FlutterStandardCodecHelper.cc.

                                                            {
  const char* utf8 = CFStringGetCStringPtr(value, kCFStringEncodingUTF8);
  if (utf8) {
    size_t length = strlen(utf8);
    FlutterStandardCodecHelperWriteSize(data, length);
    FlutterStandardCodecHelperWriteBytes(data, utf8, length);
  } else {
    CFIndex length = CFStringGetLength(value);
    CFIndex used_length = 0;
    // UTF16 length times 3 will fit all UTF8.
    CFIndex buffer_length = length * 3;
    std::vector<UInt8> buffer;
    buffer.resize(buffer_length);
    CFStringGetBytes(value, CFRangeMake(0, length), kCFStringEncodingUTF8, 0,
                     false, buffer.data(), buffer_length, &used_length);
    FlutterStandardCodecHelperWriteSize(data, used_length);
    FlutterStandardCodecHelperWriteBytes(data, buffer.data(), used_length);
  }
}

FlutterStandardFieldIsStandardType()

static bool FlutterStandardFieldIsStandardType ( uint8_t  field )

inlinestatic

Definition at line 39 of file FlutterStandardCodecHelper.h.

                                                                     {
  return field <= FlutterStandardFieldFloat32Data &&
         field >= FlutterStandardFieldNil;
}