Selector Struct Reference

Selectors are comprised of one or more SelectorSequences. More...

#include <Selector.h>

Inheritance diagram for Selector:

Public Member Functions
Class *	_Selector (void)
	The Selector archetype.
Order	compareTo (const Selector *self, const Selector *other)
	Compares this Selector to other, ordering by specificity.
void	enumerateSelection (const Selector *self, View *view, ViewEnumerator enumerator, ident data)
	Selects from view and applies the given ViewEnumerator to all matched Views.
Selector *	initWithRule (Selector *self, const char *rule)
	Initializes this Selector with the given rule.
bool	matchesView (const Selector *self, View *view)
Array *	parse (const char *rules)
	Parses the null-terminated C string of Selector rules into an Array of Selectors.
Set *	select (const Selector *self, View *view)
Set *	selectFirst (const Selector *self, View *view)

Data Fields
Object	object
	The superclass.
char *	rule
	The rule, as provided by the user.
Array *	sequences
	The sequences.
int	specificity
	The specificity.
Style *	style
	The Style.

Protected Attributes
SelectorInterface *	interface
	The interface.

Detailed Description

Selectors are comprised of one or more SelectorSequences.

Remarks

This implementation of Selectors is based on the W3's specification for CSS3.

See also

https://www.w3.org/TR/2011/REC-css3-selectors-20110929/

Definition at line 49 of file Selector.h.

Member Function Documentation

_Selector()

Class * _Selector

(

void

)

The Selector archetype.

Returns

The Selector Class.

Definition at line 504 of file Selector.c.

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

compareTo()

Order compareTo	(	const Selector *	self,
		const Selector *	other
	)

Compares this Selector to other, ordering by specificity.

Parameters

self	The Selector.
other	The Selector to compare.

Returns

The comparison result.

Definition at line 151 of file Selector.c.

                                                                    {
 
  assert(other);
 
  if (self->specificity < other->specificity) {
    return OrderAscending;
  } else if (self->specificity > other->specificity) {
    return OrderDescending;
  }
 
  return OrderSame;
}

enumerateSelection()

void enumerateSelection	(	const Selector *	self,
		View *	view,
		ViewEnumerator	enumerator,
		ident	data
	)

Selects from view and applies the given ViewEnumerator to all matched Views.

Parameters

self	The Selector.
view	The View to select from.
enumerator	The ViewEnumerator to apply to matched Views.
data	User data.

Definition at line 168 of file Selector.c.

                                                                                                        {
 
  assert(enumerator);
 
  Set *selection = $(self, select, view);
  assert(selection);
 
  Array *array = $(selection, allObjects);
  assert(array);
 
  for (size_t i = 0; i < array->count; i++) {
    enumerator($(array, objectAtIndex, i), data);
  }
 
  release(array);
  release(selection);
}

initWithRule()

Selector * initWithRule	(	Selector *	self,
		const char *	rule
	)

Initializes this Selector with the given rule.

Parameters

self	The Selector.
rule	The rule.

Returns

The initialized Selector, or NULL on error.

Definition at line 190 of file Selector.c.

                                                                {
 
  self = (Selector *) super(Object, self, init);
  if (self) {
 
    self->rule = strtrim(rule);
    assert(self->rule);
 
    self->sequences = $$(SelectorSequence, parse, self->rule);
    assert(self->sequences->count);
 
    self->specificity = specificity(self);
  }
 
  return self;
}

matchesView()

bool matchesView	(	const Selector *	self,
		View *	view
	)

Parameters

self	The Selector.
view	The View.

Returns

True if this Selector matches the given View, false otherwise.

parse()

Array * parse

(

const char *

rules

)

Parses the null-terminated C string of Selector rules into an Array of Selectors.

Parameters

rules

A null-terminated C string of Selector rules.

Returns

An Array of Selectors.

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;
}

select()

Set * select	(	const Selector *	self,
		View *	view
	)

Parameters

self	The Selector.
view	The View.

Returns

The Set of view's descendants that match this Selector.

selectFirst()

View * selectFirst	(	const Selector *	self,
		View *	view
	)

Parameters

self	The Selector.
view	The View.

Returns

The first of view's descendants that matches this Selector.

Definition at line 467 of file Selector.c.

                                                           {
 
  assert(view);
 
  Selection selection = {
    .sequences = self->sequences,
  };
 
  _selectFirst(&selection, view);
  return selection.first;
}

Field Documentation

interface

SelectorInterface* Selector::interface

protected

The interface.

Definition at line 60 of file Selector.h.

object

Object Selector::object

The superclass.

Definition at line 54 of file Selector.h.

rule

char* Selector::rule

The rule, as provided by the user.

Definition at line 70 of file Selector.h.

sequences

Array* Selector::sequences

The sequences.

Definition at line 65 of file Selector.h.

specificity

int Selector::specificity

The specificity.

See also

https://www.w3.org/TR/2011/REC-css3-selectors-20110929/#specificity

Definition at line 76 of file Selector.h.

style

Style* Selector::style

The Style.

Remarks

This is a weak reference to the Style if this Selector belongs to a Stylesheet.

Definition at line 82 of file Selector.h.

---

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

• Sources/ObjectivelyMVC/Selector.h
• Sources/ObjectivelyMVC/Selector.c