Style Struct Reference

The Style type. More...

#include <Style.h>

Inheritance diagram for Style:

Public Member Functions
Class *	_Style (void)
	The Style archetype.
void	addAttribute (Style *self, const char *attr, ident value)
	Adds or replaces the given attribute with value.
void	addAttributes (Style *self, const Dictionary *attributes)
	Adds or replaces the attribtues in attributes to this Style.
void	addBoolAttribute (Style *self, const char *attr, bool value)
	Adds or replaces the given attribute with value.
void	addCharactersAttribute (Style *self, const char *attr, const char *value)
	Adds or replaces the given attribute with value.
void	addColorAttribute (Style *self, const char *attr, const SDL_Color *value)
	Adds or replaces the given attribute with value.
void	addDoubleAttribute (Style *self, const char *attr, double value)
	Adds or replaces the given attribute with value.
void	addEnumAttribute (Style *self, const char *attr, const EnumName *names, int value)
	Adds or replaces the given attribute with value.
void	addFloatAttribute (Style *self, const char *attr, float value)
	Adds or replaces the given attribute with value.
void	addIntegerAttribute (Style *self, const char *attr, int value)
	Adds or replaces the given attribute with value.
void	addPointAttribute (Style *self, const char *attr, const SDL_Point *value)
	Adds or replaces the given attribute with value.
void	addRectangleAttribute (Style *self, const char *attr, const SDL_Rect *value)
	Adds or replaces the given attribute with value.
void	addSelector (Style *self, Selector *selector)
	Adds the given Selector to this Style.
void	addSizeAttribute (Style *self, const char *attr, const SDL_Size *value)
	Adds or replaces the given attribute with value.
ident	attributeValue (const Style *self, const char *attr)
Style *	initWithAttributes (Style *self, const Dictionary *attributes)
	Initializes this Style with the given attributes.
Style *	initWithRules (Style *self, const char *rules)
	Initializes this Style with the given CSS selector rules.
bool	isComputedEqual (const Style *self, const Style *other)
	Performs a fast, rule-based comparison of this Style to the given Style.
Array *	parse (const char *css)
	Parses the null-terminated C string of CSS definitions into an Array of Styles.
void	removeAllAttributes (Style *self)
	Removes all attributes from this Style.
void	removeAttribute (Style *self, const char *attr)
	Removes the attribute with the given name.

Data Fields
Dictionary *	attributes
Object	object
	The superclass.
Array *	selectors
	The Selectors.

Protected Attributes
StyleInterface *	interface [0]
	The interface type.

Detailed Description

The Style type.

Definition at line 43 of file Style.h.

Member Function Documentation

_Style()

Class * _Style

(

void

)

The Style archetype.

Returns

The Style Class.

Definition at line 676 of file Style.c.

                    {
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "Style",
      .superclass = _Object(),
      .instanceSize = sizeof(Style),
      .interfaceSize = sizeof(StyleInterface),
      .initialize = initialize,
    });
  });
 
  return clazz;
}

addAttribute()

void addAttribute	(	Style *	self,
		const char *	attr,
		ident	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Remarks

The value must be an Object and not a primitive.

Definition at line 196 of file Style.c.

                                                                     {
 
  assert(attr);
  assert(value);
 
  char *key = strtrim(attr);
  assert(key);
 
  setAttribute(self, key, value);
 
  free(key);
}

addAttributes()

void addAttributes	(	Style *	self,
		const Dictionary *	attributes
	)

Adds or replaces the attribtues in attributes to this Style.

Parameters

self	The Style.
attributes	The attributes.

Definition at line 221 of file Style.c.

                                                                     {
 
  assert(attributes);
 
  $(attributes, enumerateObjectsAndKeys, addAttributes_enumerate, self);
}

addBoolAttribute()

void addBoolAttribute	(	Style *	self,
		const char *	attr,
		bool	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Definition at line 232 of file Style.c.

                                                                        {
  $(self, addAttribute, attr, $$(Boole, valueof, value));
}

addCharactersAttribute()

void addCharactersAttribute	(	Style *	self,
		const char *	attr,
		const char *	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Definition at line 240 of file Style.c.

                                                                                     {
 
  String *string = $$(String, stringWithCharacters, value);
 
  $(self, addAttribute, attr, string);
 
  release(string);
}

addColorAttribute()

void addColorAttribute	(	Style *	self,
		const char *	attr,
		const SDL_Color *	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Definition at line 253 of file Style.c.

                                                                                     {
 
  Number *r = $$(Number, numberWithValue, color->r);
  Number *g = $$(Number, numberWithValue, color->g);
  Number *b = $$(Number, numberWithValue, color->b);
  Number *a = $$(Number, numberWithValue, color->a);
 
  Array *array = $$(Array, arrayWithObjects, r, g, b, a, NULL);
 
  $(self, addAttribute, attr, array);
 
  release(array);
  release(r);
  release(g);
  release(b);
  release(a);
}

addDoubleAttribute()

void addDoubleAttribute	(	Style *	self,
		const char *	attr,
		double	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Definition at line 275 of file Style.c.

                                                                            {
 
  Number *number = $$(Number, numberWithValue, value);
 
  $(self, addAttribute, attr, number);
 
  release(number);
}

addEnumAttribute()

void addEnumAttribute	(	Style *	self,
		const char *	attr,
		const EnumName *	names,
		int	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
names	The EnumNames from which to derrive the attribute value.
value	The attribute value.

Definition at line 288 of file Style.c.

                                                                                              {
 
  String *string = nameof(names, value);
 
  $(self, addAttribute, attr, string);
 
  release(string);
}

addFloatAttribute()

void addFloatAttribute	(	Style *	self,
		const char *	attr,
		float	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Definition at line 301 of file Style.c.

                                                                          {
  $(self, addDoubleAttribute, attr, value);
}

addIntegerAttribute()

void addIntegerAttribute	(	Style *	self,
		const char *	attr,
		int	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Definition at line 309 of file Style.c.

                                                                          {
  $(self, addDoubleAttribute, attr, value);
}

addPointAttribute()

void addPointAttribute	(	Style *	self,
		const char *	attr,
		const SDL_Point *	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Definition at line 317 of file Style.c.

                                                                                     {
 
  Number *x = $$(Number, numberWithValue, value->x);
  Number *y = $$(Number, numberWithValue, value->y);
 
  Array *array = $$(Array, arrayWithObjects, x, y, NULL);
 
  $(self, addAttribute, attr, array);
 
  release(array);
  release(x);
  release(y);
}

addRectangleAttribute()

void addRectangleAttribute	(	Style *	self,
		const char *	attr,
		const SDL_Rect *	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Definition at line 335 of file Style.c.

                                                                                        {
 
  Number *x = $$(Number, numberWithValue, value->x);
  Number *y = $$(Number, numberWithValue, value->y);
  Number *w = $$(Number, numberWithValue, value->w);
  Number *h = $$(Number, numberWithValue, value->h);
 
  Array *array = $$(Array, arrayWithObjects, x, y, w, h, NULL);
 
  $(self, addAttribute, attr, array);
 
  release(array);
  release(x);
  release(y);
  release(w);
  release(h);
}

addSelector()

void addSelector	(	Style *	self,
		Selector *	selector
	)

Adds the given Selector to this Style.

Parameters

self	The Style.
selector	The Selector.

Definition at line 357 of file Style.c.

                                                         {
 
  assert(selector);
 
  $((Array *) self->selectors, addObject, selector);
}

addSizeAttribute()

void addSizeAttribute	(	Style *	self,
		const char *	attr,
		const SDL_Size *	value
	)

Adds or replaces the given attribute with value.

Parameters

self	The Style.
attr	The attribute name.
value	The attribute value.

Definition at line 368 of file Style.c.

                                                                                   {
 
  Number *w = $$(Number, numberWithValue, value->w);
  Number *h = $$(Number, numberWithValue, value->h);
 
  Array *array = $$(Array, arrayWithObjects, w, h, NULL);
 
  $(self, addAttribute, attr, array);
 
  release(array);
  release(w);
  release(h);
}

attributeValue()

ident attributeValue	(	const Style *	self,
		const char *	attr
	)

Parameters

self	The Style.
attr	The attribute name.

Returns

The attribute value.

Definition at line 386 of file Style.c.

                                                                 {
  return $((Dictionary *) self->attributes, objectForKeyPath, attr);
}

initWithAttributes()

Style * initWithAttributes	(	Style *	self,
		const Dictionary *	attributes
	)

Initializes this Style with the given attributes.

Parameters

self	The Style.
attributes	The attributes.

Returns

The initialized Style, or NULL on error.

See also

View::awakeWithDictionary(View *, const Dictionary *)

Definition at line 394 of file Style.c.

                                                                            {
 
  self = $(self, initWithRules, NULL);
  if (self) {
    if (attributes) {
      $(self, addAttributes, attributes);
    }
  }
 
  return self;
}

initWithRules()

Style * initWithRules	(	Style *	self,
		const char *	rules
	)

Initializes this Style with the given CSS selector rules.

Parameters

self	The Style.
rules	A null-terminated C string of one or more Selector rules.

Returns

The initialized Style, or NULL on error.

See also

Selector::parse(const char *)

Definition at line 410 of file Style.c.

                                                            {
 
  self = (Style *) super(Object, self, init);
  if (self) {
 
    self->selectors = $$(Selector, parse, rules);
    assert(self->selectors);
 
    for (size_t i = 0; i < self->selectors->count; i++) {
      ((Selector *) self->selectors->elements[i])->style = self;
    }
 
    self->attributes = (Dictionary *) $$(Dictionary, dictionaryWithCapacity, 4);
    assert(self->attributes);
  }
 
  return self;
}

isComputedEqual()

bool isComputedEqual	(	const Style *	self,
		const Style *	other
	)

Performs a fast, rule-based comparison of this Style to the given Style.

Parameters

self	The Style.
other	The Style to test for computed equality.

Returns

True if the given Style is deemed equal, false otherwise.

Remarks

This method is optimized to quickly determine if two computed Styles should contain the same attributes based on their Selector rules. For true equality, use isEqual.

Definition at line 433 of file Style.c.

                                                                   {
 
  assert(other);
 
  if (self->selectors->count == other->selectors->count) {
 
    for (size_t i = 0; i < self->selectors->count; i++) {
 
      const Selector *this = $(self->selectors, objectAtIndex, i);
      const Selector *that = $(other->selectors, objectAtIndex, i);
 
      if (strcmp(this->rule, that->rule)) {
        return false;
      }
    }
 
    return true;
  }
 
  return false;
}

parse()

Array * parse

(

const char *

css

)

Parses the null-terminated C string of CSS definitions into an Array of Styles.

Parameters

css	The CSS definitions.

Returns

An Array of Styles.

Definition at line 291 of file Selector.c.

                                       {
 
  Array *selectors = $$(Array, arrayWithCapacity, 4);
  assert(selectors);
 
  if (rules) {
 
    const char *c = rules;
    while (*c) {
      const size_t size = strcspn(c, ",");
      if (size) {
        char *rule = calloc(1, size + 1);
        assert(rule);
 
        strncpy(rule, c, size);
 
        Selector *selector = $(alloc(Selector), initWithRule, rule);
        assert(selector);
 
        $(selectors, addObject, selector);
 
        release(selector);
        free(rule);
      }
      c += size;
      c += strspn(c, ", \t\n");
    }
  }
 
  return (Array *) selectors;
}

removeAllAttributes()

void removeAllAttributes

(

Style *

self

)

Removes all attributes from this Style.

Parameters

self	The Style.

Definition at line 634 of file Style.c.

                                             {
  $((Dictionary *) self->attributes, removeAllObjects);
}

removeAttribute()

void removeAttribute	(	Style *	self,
		const char *	attr
	)

Removes the attribute with the given name.

Parameters

self	The Style.
attr	The attribute name.

Definition at line 626 of file Style.c.

                                                           {
  $((Dictionary *) self->attributes, removeObjectForKeyPath, attr);
}

Field Documentation

attributes

Dictionary* Style::attributes

The attributes.

Definition at line 59 of file Style.h.

interface

StyleInterface* Style::interface[0]

protected

The interface type.

Definition at line 54 of file Style.h.

object

Object Style::object

The superclass.

Definition at line 48 of file Style.h.

selectors

Array* Style::selectors

The Selectors.

Definition at line 64 of file Style.h.

---

The documentation for this struct was generated from the following files:

• Sources/ObjectivelyMVC/Style.h
• Sources/ObjectivelyMVC/Style.c