Blame docs/api-importer.md

Packit bfcc33
By using custom importers, Sass stylesheets can be implemented in any possible way, such as by being loaded via a remote server. Please note: this feature is experimental and is implemented differently than importers in Ruby Sass. Imports must be relative to the parent import context and therefore we need to pass this information to the importer callback. This is currently done by passing the complete import string/path of the previous import context.
Packit bfcc33
Packit bfcc33
## Return Imports
Packit bfcc33
Packit bfcc33
You actually have to return a list of imports, since some importers may want to import multiple files from one import statement (ie. a glob/star importer).  The memory you pass with source and srcmap is taken over by LibSass and freed automatically when the import is done. You are also allowed to return `0` instead of a list, which will tell LibSass to handle the import by itself (as if no custom importer was in use).
Packit bfcc33
Packit bfcc33
```C
Packit bfcc33
Sass_Import_Entry* rv = sass_make_import_list(1);
Packit bfcc33
rv[0] = sass_make_import(rel, abs, source, srcmap);
Packit bfcc33
```
Packit bfcc33
Packit bfcc33
Every import will then be included in LibSass. You are allowed to only return a file path without any loaded source. This way you can ie. implement rewrite rules for import paths and leave the loading part for LibSass.
Packit bfcc33
Packit bfcc33
Please note that LibSass doesn't use the srcmap parameter yet. It has been added to not deprecate the C-API once support has been implemented. It will be used to re-map the actual sourcemap with the provided ones.
Packit bfcc33
Packit bfcc33
### Basic Usage
Packit bfcc33
Packit bfcc33
```C
Packit bfcc33
#include "sass/functions.h"
Packit bfcc33
```
Packit bfcc33
Packit bfcc33
## Sass Importer API
Packit bfcc33
Packit bfcc33
```C
Packit bfcc33
// Forward declaration
Packit bfcc33
struct Sass_Import;
Packit bfcc33
Packit bfcc33
// Forward declaration
Packit bfcc33
struct Sass_C_Import_Descriptor;
Packit bfcc33
Packit bfcc33
// Typedef defining the custom importer callback
Packit bfcc33
typedef struct Sass_C_Import_Descriptor (*Sass_C_Import_Callback);
Packit bfcc33
// Typedef defining the importer c function prototype
Packit bfcc33
typedef Sass_Import_Entry* (*Sass_C_Import_Fn) (const char* url, const char* prev, void* cookie);
Packit bfcc33
Packit bfcc33
// Creators for custom importer callback (with some additional pointer)
Packit bfcc33
// The pointer is mostly used to store the callback into the actual function
Packit bfcc33
Sass_C_Import_Callback sass_make_importer (Sass_C_Import_Fn, void* cookie);
Packit bfcc33
Packit bfcc33
// Getters for import function descriptors
Packit bfcc33
Sass_C_Import_Fn sass_import_get_function (Sass_C_Import_Callback fn);
Packit bfcc33
void* sass_import_get_cookie (Sass_C_Import_Callback fn);
Packit bfcc33
Packit bfcc33
// Deallocator for associated memory
Packit bfcc33
void sass_delete_importer (Sass_C_Import_Callback fn);
Packit bfcc33
Packit bfcc33
// Creator for sass custom importer return argument list
Packit bfcc33
Sass_Import_Entry* sass_make_import_list (size_t length);
Packit bfcc33
// Creator for a single import entry returned by the custom importer inside the list
Packit bfcc33
Sass_Import_Entry sass_make_import_entry (const char* path, char* source, char* srcmap);
Packit bfcc33
Sass_Import_Entry sass_make_import (const char* rel, const char* abs, char* source, char* srcmap);
Packit bfcc33
Packit bfcc33
// set error message to abort import and to print out a message (path from existing object is used in output)
Packit bfcc33
Sass_Import_Entry sass_import_set_error(Sass_Import_Entry import, const char* message, size_t line, size_t col);
Packit bfcc33
Packit bfcc33
// Setters to insert an entry into the import list (you may also use [] access directly)
Packit bfcc33
// Since we are dealing with pointers they should have a guaranteed and fixed size
Packit bfcc33
void sass_import_set_list_entry (Sass_Import_Entry* list, size_t idx, Sass_Import_Entry entry);
Packit bfcc33
Sass_Import_Entry sass_import_get_list_entry (Sass_Import_Entry* list, size_t idx);
Packit bfcc33
Packit bfcc33
// Getters for import entry
Packit bfcc33
const char* sass_import_get_imp_path (Sass_Import_Entry);
Packit bfcc33
const char* sass_import_get_abs_path (Sass_Import_Entry);
Packit bfcc33
const char* sass_import_get_source (Sass_Import_Entry);
Packit bfcc33
const char* sass_import_get_srcmap (Sass_Import_Entry);
Packit bfcc33
// Explicit functions to take ownership of these items
Packit bfcc33
// The property on our struct will be reset to NULL
Packit bfcc33
char* sass_import_take_source (Sass_Import_Entry);
Packit bfcc33
char* sass_import_take_srcmap (Sass_Import_Entry);
Packit bfcc33
Packit bfcc33
// Getters for import error entries
Packit bfcc33
size_t sass_import_get_error_line (Sass_Import_Entry);
Packit bfcc33
size_t sass_import_get_error_column (Sass_Import_Entry);
Packit bfcc33
const char* sass_import_get_error_message (Sass_Import_Entry);
Packit bfcc33
Packit bfcc33
// Deallocator for associated memory (incl. entries)
Packit bfcc33
void sass_delete_import_list (Sass_Import_Entry*);
Packit bfcc33
// Just in case we have some stray import structs
Packit bfcc33
void sass_delete_import (Sass_Import_Entry);
Packit bfcc33
```
Packit bfcc33
Packit bfcc33
### More links
Packit bfcc33
Packit bfcc33
- [Sass Importer Example](api-importer-example.md)
Packit bfcc33
- [Sass Importer Internal](api-importer-internal.md)
Packit bfcc33