Enum.h File Reference

Named enumerations. More...

#include <Objectively/Types.h>
#include <Objectively/String.h>

Go to the source code of this file.

Data Structures
struct	EnumName
	The EnumName type. More...

Macros
#define	MakeEnumAlias(en, al)
	Creates an EnumName alias for en for use with valueof.
#define	MakeEnumName(en)
	Creates an EnumName for en for use with valueof.
#define	MakeEnumNames(...)
	Creates a null-terminated array of EnumNames.

Functions
OBJECTIVELY_EXPORT String *	nameof (const EnumName *names, int value)
	Marshal value, returning a String of OR'ed EnumNames for the given enum value.
OBJECTIVELY_EXPORT int	valueof (const EnumName *names, const char *chars)
	Parse string, returning the corresponding enum value.

Detailed Description

Named enumerations.

Definition in file Enum.h.

Macro Definition Documentation

MakeEnumAlias

#define MakeEnumAlias	(		en,
			al
	)

Value:

  { \
    .name = #en, \
    .alias = #al, \
    .value = en, \
  }

Creates an EnumName alias for en for use with valueof.

See also

valueof(constEnumName *, const char *, int)

Definition at line 58 of file Enum.h.

  { \
    .name = #en, \
    .alias = #al, \
    .value = en, \
  }

MakeEnumName

#define MakeEnumName

(

en

)

Value:

  { \
    .name = #en, \
    .alias = NULL, \
    .value = en, \
  }

Creates an EnumName for en for use with valueof.

See also

valueof(const EnumName *, const char *, int)

Definition at line 47 of file Enum.h.

  { \
    .name = #en, \
    .alias = NULL, \
    .value = en, \
  }

MakeEnumNames

#define MakeEnumNames

(

...

)

Value:

  { \
    __VA_ARGS__, \
    { \
      .name = NULL, \
      .value = 0 \
    } \
  }

Creates a null-terminated array of EnumNames.

Definition at line 68 of file Enum.h.

  { \
    __VA_ARGS__, \
    { \
      .name = NULL, \
      .value = 0 \
    } \
  }

Function Documentation

nameof()

OBJECTIVELY_EXPORT String * nameof	(	const EnumName *	names,
		int	value
	)

Marshal value, returning a String of OR'ed EnumNames for the given enum value.

Parameters

names	A null-terminated array of EnumNames.
value	The enum value, which may be a bitwise OR of multiple enum values.

Returns

A String of EnumNames matching value, or NULL.

Definition at line 31 of file Enum.c.

                                                 {
 
  for (const EnumName *name = names; name->name; name++) {
    if (name->value == value) {
      return $$(String, stringWithCharacters, name->name);
    }
  }
 
  String *string = NULL;
 
  for (const EnumName *name = names; name->name; name++) {
    if (name->value) {
      if ((name->value & value) == name->value) {
        if (string == NULL) {
          string = $$(String, string);
        } else {
          $(string, appendCharacters, " | ");
        }
        $(string, appendCharacters, name->name);
      }
    }
  }
 
  return (String *) string;
}

valueof()

OBJECTIVELY_EXPORT int valueof	(	const EnumName *	names,
		const char *	chars
	)

Parse string, returning the corresponding enum value.

Parameters

names	A null-terminated array of EnumNames.
chars	A null-terminated C string.

Returns

The value of the EnumName matching string, or -1.

Definition at line 57 of file Enum.c.

                                                      {
 
  int value = 0;
 
  const char *c = chars;
  while (*c) {
    const size_t size = strcspn(c, " |");
    if (size) {
      const EnumName *en;
      for (en = names; en->name; en++) {
        if (strncmp(en->name, c, size) == 0) {
          value |= en->value;
          break;
        }
        if (en->alias && strncmp(en->alias, c, size) == 0) {
          value |= en->value;
          break;
        }
      }
      if (en->name == NULL) {
        fprintf(stderr, "%s: Unknown character sequence: %s\n", __func__, c);
      }
    }
    c += size;
    c += strspn(c, " |");
  }
 
  return value;
}