Blame include/sass/values.h

Packit bfcc33
#ifndef SASS_C_VALUES_H
Packit bfcc33
#define SASS_C_VALUES_H
Packit bfcc33
Packit bfcc33
#include <stddef.h>
Packit bfcc33
#include <stdbool.h>
Packit bfcc33
#include <sass/base.h>
Packit bfcc33
Packit bfcc33
#ifdef __cplusplus
Packit bfcc33
extern "C" {
Packit bfcc33
#endif
Packit bfcc33
Packit bfcc33
Packit bfcc33
// Forward declaration
Packit bfcc33
union Sass_Value;
Packit bfcc33
Packit bfcc33
// Type for Sass values
Packit bfcc33
enum Sass_Tag {
Packit bfcc33
  SASS_BOOLEAN,
Packit bfcc33
  SASS_NUMBER,
Packit bfcc33
  SASS_COLOR,
Packit bfcc33
  SASS_STRING,
Packit bfcc33
  SASS_LIST,
Packit bfcc33
  SASS_MAP,
Packit bfcc33
  SASS_NULL,
Packit bfcc33
  SASS_ERROR,
Packit bfcc33
  SASS_WARNING
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// Tags for denoting Sass list separators
Packit bfcc33
enum Sass_Separator {
Packit bfcc33
  SASS_COMMA,
Packit bfcc33
  SASS_SPACE,
Packit bfcc33
  // only used internally to represent a hash map before evaluation
Packit bfcc33
  // otherwise we would be too early to check for duplicate keys
Packit bfcc33
  SASS_HASH
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// Value Operators
Packit bfcc33
enum Sass_OP {
Packit bfcc33
  AND, OR,                   // logical connectives
Packit bfcc33
  EQ, NEQ, GT, GTE, LT, LTE, // arithmetic relations
Packit bfcc33
  ADD, SUB, MUL, DIV, MOD,   // arithmetic functions
Packit bfcc33
  NUM_OPS                    // so we know how big to make the op table
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// Creator functions for all value types
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_null    (void);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_boolean (bool val);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_string  (const char* val);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_qstring (const char* val);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_number  (double val, const char* unit);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_color   (double r, double g, double b, double a);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_list    (size_t len, enum Sass_Separator sep);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_map     (size_t len);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_error   (const char* msg);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_make_warning (const char* msg);
Packit bfcc33
Packit bfcc33
// Generic destructor function for all types
Packit bfcc33
// Will release memory of all associated Sass_Values
Packit bfcc33
// Means we will delete recursively for lists and maps
Packit bfcc33
ADDAPI void ADDCALL sass_delete_value (union Sass_Value* val);
Packit bfcc33
Packit bfcc33
// Make a deep cloned copy of the given sass value
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_clone_value (const union Sass_Value* val);
Packit bfcc33
Packit bfcc33
// Execute an operation for two Sass_Values and return the result as a Sass_Value too
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_value_op (enum Sass_OP op, const union Sass_Value* a, const union Sass_Value* b);
Packit bfcc33
Packit bfcc33
// Stringify a Sass_Values and also return the result as a Sass_Value (of type STRING)
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_value_stringify (const union Sass_Value* a, bool compressed, int precision);
Packit bfcc33
Packit bfcc33
// Return the sass tag for a generic sass value
Packit bfcc33
// Check is needed before accessing specific values!
Packit bfcc33
ADDAPI enum Sass_Tag ADDCALL sass_value_get_tag (const union Sass_Value* v);
Packit bfcc33
Packit bfcc33
// Check value to be of a specific type
Packit bfcc33
// Can also be used before accessing properties!
Packit bfcc33
ADDAPI bool ADDCALL sass_value_is_null (const union Sass_Value* v);
Packit bfcc33
ADDAPI bool ADDCALL sass_value_is_number (const union Sass_Value* v);
Packit bfcc33
ADDAPI bool ADDCALL sass_value_is_string (const union Sass_Value* v);
Packit bfcc33
ADDAPI bool ADDCALL sass_value_is_boolean (const union Sass_Value* v);
Packit bfcc33
ADDAPI bool ADDCALL sass_value_is_color (const union Sass_Value* v);
Packit bfcc33
ADDAPI bool ADDCALL sass_value_is_list (const union Sass_Value* v);
Packit bfcc33
ADDAPI bool ADDCALL sass_value_is_map (const union Sass_Value* v);
Packit bfcc33
ADDAPI bool ADDCALL sass_value_is_error (const union Sass_Value* v);
Packit bfcc33
ADDAPI bool ADDCALL sass_value_is_warning (const union Sass_Value* v);
Packit bfcc33
Packit bfcc33
// Getters and setters for Sass_Number
Packit bfcc33
ADDAPI double ADDCALL sass_number_get_value (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_number_set_value (union Sass_Value* v, double value);
Packit bfcc33
ADDAPI const char* ADDCALL sass_number_get_unit (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_number_set_unit (union Sass_Value* v, char* unit);
Packit bfcc33
Packit bfcc33
// Getters and setters for Sass_String
Packit bfcc33
ADDAPI const char* ADDCALL sass_string_get_value (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_string_set_value (union Sass_Value* v, char* value);
Packit bfcc33
ADDAPI bool ADDCALL sass_string_is_quoted(const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_string_set_quoted(union Sass_Value* v, bool quoted);
Packit bfcc33
Packit bfcc33
// Getters and setters for Sass_Boolean
Packit bfcc33
ADDAPI bool ADDCALL sass_boolean_get_value (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_boolean_set_value (union Sass_Value* v, bool value);
Packit bfcc33
Packit bfcc33
// Getters and setters for Sass_Color
Packit bfcc33
ADDAPI double ADDCALL sass_color_get_r (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_color_set_r (union Sass_Value* v, double r);
Packit bfcc33
ADDAPI double ADDCALL sass_color_get_g (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_color_set_g (union Sass_Value* v, double g);
Packit bfcc33
ADDAPI double ADDCALL sass_color_get_b (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_color_set_b (union Sass_Value* v, double b);
Packit bfcc33
ADDAPI double ADDCALL sass_color_get_a (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_color_set_a (union Sass_Value* v, double a);
Packit bfcc33
Packit bfcc33
// Getter for the number of items in list
Packit bfcc33
ADDAPI size_t ADDCALL sass_list_get_length (const union Sass_Value* v);
Packit bfcc33
// Getters and setters for Sass_List
Packit bfcc33
ADDAPI enum Sass_Separator ADDCALL sass_list_get_separator (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_list_set_separator (union Sass_Value* v, enum Sass_Separator value);
Packit bfcc33
// Getters and setters for Sass_List values
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_list_get_value (const union Sass_Value* v, size_t i);
Packit bfcc33
ADDAPI void ADDCALL sass_list_set_value (union Sass_Value* v, size_t i, union Sass_Value* value);
Packit bfcc33
Packit bfcc33
// Getter for the number of items in map
Packit bfcc33
ADDAPI size_t ADDCALL sass_map_get_length (const union Sass_Value* v);
Packit bfcc33
// Getters and setters for Sass_Map keys and values
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_map_get_key (const union Sass_Value* v, size_t i);
Packit bfcc33
ADDAPI void ADDCALL sass_map_set_key (union Sass_Value* v, size_t i, union Sass_Value*);
Packit bfcc33
ADDAPI union Sass_Value* ADDCALL sass_map_get_value (const union Sass_Value* v, size_t i);
Packit bfcc33
ADDAPI void ADDCALL sass_map_set_value (union Sass_Value* v, size_t i, union Sass_Value*);
Packit bfcc33
Packit bfcc33
// Getters and setters for Sass_Error
Packit bfcc33
ADDAPI char* ADDCALL sass_error_get_message (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_error_set_message (union Sass_Value* v, char* msg);
Packit bfcc33
Packit bfcc33
// Getters and setters for Sass_Warning
Packit bfcc33
ADDAPI char* ADDCALL sass_warning_get_message (const union Sass_Value* v);
Packit bfcc33
ADDAPI void ADDCALL sass_warning_set_message (union Sass_Value* v, char* msg);
Packit bfcc33
Packit bfcc33
#ifdef __cplusplus
Packit bfcc33
} // __cplusplus defined.
Packit bfcc33
#endif
Packit bfcc33
Packit bfcc33
#endif