Blame docs/api-context-internal.md

Packit bfcc33
```C
Packit bfcc33
// Input behaviours
Packit bfcc33
enum Sass_Input_Style {
Packit bfcc33
  SASS_CONTEXT_NULL,
Packit bfcc33
  SASS_CONTEXT_FILE,
Packit bfcc33
  SASS_CONTEXT_DATA,
Packit bfcc33
  SASS_CONTEXT_FOLDER
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// sass config options structure
Packit bfcc33
struct Sass_Inspect_Options {
Packit bfcc33
Packit bfcc33
  // Output style for the generated css code
Packit bfcc33
  // A value from above SASS_STYLE_* constants
Packit bfcc33
  enum Sass_Output_Style output_style;
Packit bfcc33
Packit bfcc33
  // Precision for fractional numbers
Packit bfcc33
  int precision;
Packit bfcc33
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// sass config options structure
Packit bfcc33
struct Sass_Output_Options : Sass_Inspect_Options {
Packit bfcc33
Packit bfcc33
  // String to be used for indentation
Packit bfcc33
  const char* indent;
Packit bfcc33
  // String to be used to for line feeds
Packit bfcc33
  const char* linefeed;
Packit bfcc33
Packit bfcc33
  // Emit comments in the generated CSS indicating
Packit bfcc33
  // the corresponding source line.
Packit bfcc33
  bool source_comments;
Packit bfcc33
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// sass config options structure
Packit bfcc33
struct Sass_Options : Sass_Output_Options {
Packit bfcc33
Packit bfcc33
  // embed sourceMappingUrl as data uri
Packit bfcc33
  bool source_map_embed;
Packit bfcc33
Packit bfcc33
  // embed include contents in maps
Packit bfcc33
  bool source_map_contents;
Packit bfcc33
Packit bfcc33
  // create file urls for sources
Packit bfcc33
  bool source_map_file_urls;
Packit bfcc33
Packit bfcc33
  // Disable sourceMappingUrl in css output
Packit bfcc33
  bool omit_source_map_url;
Packit bfcc33
Packit bfcc33
  // Treat source_string as sass (as opposed to scss)
Packit bfcc33
  bool is_indented_syntax_src;
Packit bfcc33
Packit bfcc33
  // The input path is used for source map
Packit bfcc33
  // generation. It can be used to define
Packit bfcc33
  // something with string compilation or to
Packit bfcc33
  // overload the input file path. It is
Packit bfcc33
  // set to "stdin" for data contexts and
Packit bfcc33
  // to the input file on file contexts.
Packit bfcc33
  char* input_path;
Packit bfcc33
Packit bfcc33
  // The output path is used for source map
Packit bfcc33
  // generation. LibSass will not write to
Packit bfcc33
  // this file, it is just used to create
Packit bfcc33
  // information in source-maps etc.
Packit bfcc33
  char* output_path;
Packit bfcc33
Packit bfcc33
  // Colon-separated list of paths
Packit bfcc33
  // Semicolon-separated on Windows
Packit bfcc33
  // Maybe use array interface instead?
Packit bfcc33
  char* include_path;
Packit bfcc33
  char* plugin_path;
Packit bfcc33
Packit bfcc33
  // Include paths (linked string list)
Packit bfcc33
  struct string_list* include_paths;
Packit bfcc33
  // Plugin paths (linked string list)
Packit bfcc33
  struct string_list* plugin_paths;
Packit bfcc33
Packit bfcc33
  // Path to source map file
Packit bfcc33
  // Enables source map generation
Packit bfcc33
  // Used to create sourceMappingUrl
Packit bfcc33
  char* source_map_file;
Packit bfcc33
Packit bfcc33
  // Directly inserted in source maps
Packit bfcc33
  char* source_map_root;
Packit bfcc33
Packit bfcc33
  // Custom functions that can be called from sccs code
Packit bfcc33
  Sass_Function_List c_functions;
Packit bfcc33
Packit bfcc33
  // Callback to overload imports
Packit bfcc33
  Sass_Importer_List c_importers;
Packit bfcc33
Packit bfcc33
  // List of custom headers
Packit bfcc33
  Sass_Importer_List c_headers;
Packit bfcc33
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// base for all contexts
Packit bfcc33
struct Sass_Context : Sass_Options
Packit bfcc33
{
Packit bfcc33
Packit bfcc33
  // store context type info
Packit bfcc33
  enum Sass_Input_Style type;
Packit bfcc33
Packit bfcc33
  // generated output data
Packit bfcc33
  char* output_string;
Packit bfcc33
Packit bfcc33
  // generated source map json
Packit bfcc33
  char* source_map_string;
Packit bfcc33
Packit bfcc33
  // error status
Packit bfcc33
  int error_status;
Packit bfcc33
  char* error_json;
Packit bfcc33
  char* error_text;
Packit bfcc33
  char* error_message;
Packit bfcc33
  // error position
Packit bfcc33
  char* error_file;
Packit bfcc33
  size_t error_line;
Packit bfcc33
  size_t error_column;
Packit bfcc33
  const char* error_src;
Packit bfcc33
Packit bfcc33
  // report imported files
Packit bfcc33
  char** included_files;
Packit bfcc33
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// struct for file compilation
Packit bfcc33
struct Sass_File_Context : Sass_Context {
Packit bfcc33
Packit bfcc33
  // no additional fields required
Packit bfcc33
  // input_path is already on options
Packit bfcc33
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// struct for data compilation
Packit bfcc33
struct Sass_Data_Context : Sass_Context {
Packit bfcc33
Packit bfcc33
  // provided source string
Packit bfcc33
  char* source_string;
Packit bfcc33
  char* srcmap_string;
Packit bfcc33
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// Compiler states
Packit bfcc33
enum Sass_Compiler_State {
Packit bfcc33
  SASS_COMPILER_CREATED,
Packit bfcc33
  SASS_COMPILER_PARSED,
Packit bfcc33
  SASS_COMPILER_EXECUTED
Packit bfcc33
};
Packit bfcc33
Packit bfcc33
// link c and cpp context
Packit bfcc33
struct Sass_Compiler {
Packit bfcc33
  // progress status
Packit bfcc33
  Sass_Compiler_State state;
Packit bfcc33
  // original c context
Packit bfcc33
  Sass_Context* c_ctx;
Packit bfcc33
  // Sass::Context
Packit bfcc33
  Sass::Context* cpp_ctx;
Packit bfcc33
  // Sass::Block
Packit bfcc33
  Sass::Block_Obj root;
Packit bfcc33
};
Packit bfcc33
```
Packit bfcc33