Refactor C-API path handling

- Removes sass_option_get_plugin_path(opt)
- Removes sass_option_get_include_path(opt)

Removed path options are colon-separated lists of paths.
Most implementations will probably only want to use
the push functions for paths. We still support the old
way to set this option in order to help support SASS_PATH
environment variables (implementers can just pass it in).
Use the new query functions if you need them.

- Adds sass_option_get_include_path_size(opt)
- Adds sass_option_get_include_path(opt, i)
- Fixes a minor memory leak with plugins
- Adds sass_compiler_find_include(file, comp)
- Adds sass_compiler_find_file(file, comp)
- Adds sass_find_include(file, opt)
- Adds sass_find_file(file, opt)

Author: mgreter

docs/api-context-internal.md

@@ -7,26 +7,35 @@ enum Sass_Input_Style {
   SASS_CONTEXT_FOLDER
 };
 
-// simple linked list
-struct string_list {
-  string_list* next;
-  char* string;
-};
-
 // sass config options structure
-struct Sass_Options {
-
-  // Precision for fractional numbers
-  int precision;
+struct Sass_Inspect_Options {
 
   // Output style for the generated css code
   // A value from above SASS_STYLE_* constants
   enum Sass_Output_Style output_style;
 
+  // Precision for fractional numbers
+  int precision;
+
+};
+
+// sass config options structure
+struct Sass_Output_Options : Sass_Inspect_Options {
+
+  // String to be used for indentation
+  const char* indent;
+  // String to be used to for line feeds
+  const char* linefeed;
+
   // Emit comments in the generated CSS indicating
   // the corresponding source line.
   bool source_comments;
 
+};
+
+// sass config options structure
+struct Sass_Options : Sass_Output_Options {
+
   // embed sourceMappingUrl as data uri
   bool source_map_embed;
 
@@ -56,15 +65,9 @@ struct Sass_Options {
   // information in source-maps etc.
   char* output_path;
 
-  // String to be used for indentation
-  const char* indent;
-  // String to be used to for line feeds
-  const char* linefeed;
-
   // Colon-separated list of paths
   // Semicolon-separated on Windows
-  // Note: It may be better to use
-  // array interface instead
+  // Maybe use array interface instead?
   char* include_path;
   char* plugin_path;
 
@@ -82,10 +85,13 @@ struct Sass_Options {
   char* source_map_root;
 
   // Custom functions that can be called from sccs code
-  Sass_C_Function_List c_functions;
+  Sass_Function_List c_functions;
 
   // Callback to overload imports
-  Sass_C_Import_Callback importer;
+  Sass_Importer_List c_importers;
+
+  // List of custom headers
+  Sass_Importer_List c_headers;
 
 };
 
@@ -111,6 +117,7 @@ struct Sass_Context : Sass_Options
   char* error_file;
   size_t error_line;
   size_t error_column;
+  const char* error_src;
 
   // report imported files
   char** included_files;
@@ -130,6 +137,7 @@ struct Sass_Data_Context : Sass_Context {
 
   // provided source string
   char* source_string;
+  char* srcmap_string;
 
 };
 
@@ -147,9 +155,9 @@ struct Sass_Compiler {
   // original c context
   Sass_Context* c_ctx;
   // Sass::Context
-  void* cpp_ctx;
+  Sass::Context* cpp_ctx;
   // Sass::Block
-  void* root;
+  Sass::Block_Obj root;
 };
 ```
 

docs/api-context.md

@@ -223,10 +223,6 @@ char* sass_context_take_error_message (struct Sass_Context* ctx);
 char* sass_context_take_error_file (struct Sass_Context* ctx);
 char* sass_context_take_output_string (struct Sass_Context* ctx);
 char* sass_context_take_source_map_string (struct Sass_Context* ctx);
-
-// Push function for plugin/include paths (no manipulation support for now)
-void sass_option_push_plugin_path (struct Sass_Options* options, const char* path);
-void sass_option_push_include_path (struct Sass_Options* options, const char* path);
 ```
 
 ### Sass Options API
@@ -245,13 +241,15 @@ const char* sass_option_get_indent (struct Sass_Options* options);
 const char* sass_option_get_linefeed (struct Sass_Options* options);
 const char* sass_option_get_input_path (struct Sass_Options* options);
 const char* sass_option_get_output_path (struct Sass_Options* options);
-const char* sass_option_get_plugin_path (struct Sass_Options* options);
-const char* sass_option_get_include_path (struct Sass_Options* options);
 const char* sass_option_get_source_map_file (struct Sass_Options* options);
 const char* sass_option_get_source_map_root (struct Sass_Options* options);
 Sass_C_Function_List sass_option_get_c_functions (struct Sass_Options* options);
 Sass_C_Import_Callback sass_option_get_importer (struct Sass_Options* options);
 
+// Getters for Context_Option include path array
+size_t sass_option_get_include_path_size(struct Sass_Options* options);
+const char* sass_option_get_include_path(struct Sass_Options* options, size_t i);
+
 // Setters for Context_Option values
 void sass_option_set_precision (struct Sass_Options* options, int precision);
 void sass_option_set_output_style (struct Sass_Options* options, enum Sass_Output_Style output_style);
@@ -275,6 +273,16 @@ void sass_option_set_importer (struct Sass_Options* options, Sass_C_Import_Callb
 // Push function for paths (no manipulation support for now)
 void sass_option_push_plugin_path (struct Sass_Options* options, const char* path);
 void sass_option_push_include_path (struct Sass_Options* options, const char* path);
+
+// Resolve a file via the given include paths in the sass option struct
+// find_file looks for the exact file name while find_include does a regular sass include
+char* sass_find_file (const char* path, struct Sass_Options* opt);
+char* sass_find_include (const char* path, struct Sass_Options* opt);
+
+// Resolve a file relative to last import or include paths in the sass option struct
+// find_file looks for the exact file name while find_include does a regular sass include
+char* sass_compiler_find_file (const char* path, struct Sass_Compiler* compiler);
+char* sass_compiler_find_include (const char* path, struct Sass_Compiler* compiler);
 ```
 
 ### More links

docs/api-doc.md

@@ -125,9 +125,6 @@ void sass_free_memory(void* ptr);
 char* sass_string_unquote (const char* str);
 char* sass_string_quote (const char* str, const char quote_mark);
 
-// Resolve a file via the given include paths in the include char* array
-char* sass_resolve_file (const char* path, const char* incs[]);
-
 // Get compiled libsass version
 const char* libsass_version(void);
 

include/sass/base.h

@@ -75,9 +75,6 @@ ADDAPI void ADDCALL sass_free_memory(void* ptr);
 ADDAPI char* ADDCALL sass_string_quote (const char* str, const char quote_mark);
 ADDAPI char* ADDCALL sass_string_unquote (const char* str);
 
-// Resolve a file via the given include paths in the include char* array
-ADDAPI char* ADDCALL sass_resolve_file (const char* path, const char* incs[]);
-
 // Implemented sass language version
 // Hardcoded version 3.4 for time being
 ADDAPI const char* ADDCALL libsass_version(void);

include/sass/context.h

@@ -81,8 +81,6 @@ ADDAPI const char* ADDCALL sass_option_get_indent (struct Sass_Options* options)
 ADDAPI const char* ADDCALL sass_option_get_linefeed (struct Sass_Options* options);
 ADDAPI const char* ADDCALL sass_option_get_input_path (struct Sass_Options* options);
 ADDAPI const char* ADDCALL sass_option_get_output_path (struct Sass_Options* options);
-ADDAPI const char* ADDCALL sass_option_get_plugin_path (struct Sass_Options* options);
-ADDAPI const char* ADDCALL sass_option_get_include_path (struct Sass_Options* options);
 ADDAPI const char* ADDCALL sass_option_get_source_map_file (struct Sass_Options* options);
 ADDAPI const char* ADDCALL sass_option_get_source_map_root (struct Sass_Options* options);
 ADDAPI Sass_Importer_List ADDCALL sass_option_get_c_headers (struct Sass_Options* options);
@@ -124,6 +122,10 @@ ADDAPI size_t ADDCALL sass_context_get_error_column (struct Sass_Context* ctx);
 ADDAPI const char* ADDCALL sass_context_get_source_map_string (struct Sass_Context* ctx);
 ADDAPI char** ADDCALL sass_context_get_included_files (struct Sass_Context* ctx);
 
+// Getters for options include path array
+ADDAPI size_t ADDCALL sass_option_get_include_path_size(struct Sass_Options* options);
+ADDAPI const char* ADDCALL sass_option_get_include_path(struct Sass_Options* options, size_t i);
+
 // Calculate the size of the stored null terminated array
 ADDAPI size_t ADDCALL sass_context_get_included_files_size (struct Sass_Context* ctx);
 
@@ -151,6 +153,16 @@ ADDAPI Sass_Callee_Entry ADDCALL sass_compiler_get_callee_entry(struct Sass_Comp
 ADDAPI void ADDCALL sass_option_push_plugin_path (struct Sass_Options* options, const char* path);
 ADDAPI void ADDCALL sass_option_push_include_path (struct Sass_Options* options, const char* path);
 
+// Resolve a file via the given include paths in the sass option struct
+// find_file looks for the exact file name while find_include does a regular sass include
+ADDAPI char* ADDCALL sass_find_file (const char* path, struct Sass_Options* opt);
+ADDAPI char* ADDCALL sass_find_include (const char* path, struct Sass_Options* opt);
+
+// Resolve a file relative to last import or include paths in the sass option struct
+// find_file looks for the exact file name while find_include does a regular sass include
+ADDAPI char* ADDCALL sass_compiler_find_file (const char* path, struct Sass_Compiler* compiler);
+ADDAPI char* ADDCALL sass_compiler_find_include (const char* path, struct Sass_Compiler* compiler);
+
 #ifdef __cplusplus
 } // __cplusplus defined.
 #endif

include/sass/functions.h

@@ -51,6 +51,7 @@ enum Sass_Callee_Type {
 ADDAPI Sass_Importer_List ADDCALL sass_make_importer_list (size_t length);
 ADDAPI Sass_Importer_Entry ADDCALL sass_importer_get_list_entry (Sass_Importer_List list, size_t idx);
 ADDAPI void ADDCALL sass_importer_set_list_entry (Sass_Importer_List list, size_t idx, Sass_Importer_Entry entry);
+ADDAPI void ADDCALL sass_delete_importer_list (Sass_Importer_List list);
 
 
 // Creators for custom importer callback (with some additional pointer)
@@ -118,6 +119,8 @@ ADDAPI void ADDCALL sass_delete_import (Sass_Import_Entry);
 // Creators for sass function list and function descriptors
 ADDAPI Sass_Function_List ADDCALL sass_make_function_list (size_t length);
 ADDAPI Sass_Function_Entry ADDCALL sass_make_function (const char* signature, Sass_Function_Fn cb, void* cookie);
+ADDAPI void ADDCALL sass_delete_function (Sass_Function_Entry entry);
+ADDAPI void ADDCALL sass_delete_function_list (Sass_Function_List list);
 
 // Setters and getters for callbacks on function lists
 ADDAPI Sass_Function_Entry ADDCALL sass_function_get_list_entry(Sass_Function_List list, size_t pos);

script/ci-build-libsass

@@ -37,7 +37,7 @@ fi
 if [ "$(expr substr $(uname -s) 1 10)" == "MINGW32_NT" ]; then
   MAKE_OPTS="$MAKE_OPTS -j1 V=1"
 else
-  MAKE_OPTS="$MAKE_OPTS -j3 V=1"
+  MAKE_OPTS="$MAKE_OPTS -j5 V=1"
 fi
 
 if [ "x$PREFIX" == "x" ]; then

src/context.cpp

@@ -667,7 +667,7 @@ namespace Sass {
 
     // clean up by removing empty placeholders
     // ToDo: maybe we can do this somewhere else?
-    Remove_Placeholders remove_placeholders(*this);
+    Remove_Placeholders remove_placeholders;
     root->perform(&remove_placeholders);
     // return processed tree
     return root;

src/eval.cpp

@@ -1012,8 +1012,8 @@ namespace Sass {
       value = SASS_MEMORY_CAST(Expression, (*env)[name]);
     }
     else error("Undefined variable: \"" + v->name() + "\".", v->pstate());
-    if (typeid(*value) == typeid(Argument)) {
-      value = SASS_MEMORY_CAST(Argument, value)->value();
+    if (Argument* arg = SASS_MEMORY_CAST(Argument, value)) {
+      value = arg->value();
     }
 
     // behave according to as ruby sass (add leading zero)

src/extend.cpp

@@ -1933,7 +1933,7 @@ namespace Sass {
       }
     }
 
-    Remove_Placeholders remove_placeholders(ctx);
+    Remove_Placeholders remove_placeholders;
     // it seems that we have to remove the place holders early here
     // normally we do this as the very last step (compare to ruby sass)
     pNewSelectors = remove_placeholders.remove_placeholders(&pNewSelectors);

src/file.cpp

@@ -20,6 +20,7 @@
 #include "context.hpp"
 #include "prelexer.hpp"
 #include "utf8_string.hpp"
+#include "sass_functions.hpp"
 #include "sass2scss.h"
 
 #ifdef _WIN32
@@ -301,13 +302,9 @@ namespace Sass {
     // (2) underscore + given
     // (3) underscore + given + extension
     // (4) given + extension
-    std::vector<Include> resolve_includes(const std::string& root, const std::string& file)
+    std::vector<Include> resolve_includes(const std::string& root, const std::string& file, const std::vector<std::string>& exts)
     {
       std::string filename = join_paths(root, file);
-      // supported extensions
-      const std::vector<std::string> exts = {
-        ".scss", ".sass", ".css"
-      };
       // split the filename
       std::string base(dir_name(file));
       std::string name(base_name(file));
@@ -336,8 +333,41 @@ namespace Sass {
       return includes;
     }
 
-    // helper function to resolve a filename
+    std::vector<std::string> find_files(const std::string& file, const std::vector<std::string> paths)
+    {
+      std::vector<std::string> includes;
+      for (std::string path : paths) {
+        std::string abs_path(join_paths(path, file));
+        if (file_exists(abs_path)) includes.push_back(abs_path);
+      }
+      return includes;
+    }
+
+    std::vector<std::string> find_files(const std::string& file, struct Sass_Compiler* compiler)
+    {
+      // get the last import entry to get current base directory
+      // struct Sass_Options* options = sass_compiler_get_options(compiler);
+      Sass_Import_Entry import = sass_compiler_get_last_import(compiler);
+      const std::vector<std::string>& incs = compiler->cpp_ctx->include_paths;
+      // create the vector with paths to lookup
+      std::vector<std::string> paths(1 + incs.size());
+      paths.push_back(dir_name(import->abs_path));
+      paths.insert(paths.end(), incs.begin(), incs.end());
+      // dispatch to find files in paths
+      return find_files(file, paths);
+    }
+
+    // helper function to search one file in all include paths
+    // this is normally not used internally by libsass (C-API sugar)
     std::string find_file(const std::string& file, const std::vector<std::string> paths)
+    {
+      if (file.empty()) return file;
+      auto res = find_files(file, paths);
+      return res.empty() ? "" : res.front();
+    }
+
+    // helper function to resolve a filename
+    std::string find_include(const std::string& file, const std::vector<std::string> paths)
     {
       // search in every include path for a match
       for (size_t i = 0, S = paths.size(); i < S; ++i)
@@ -349,20 +379,6 @@ namespace Sass {
       return std::string("");
     }
 
-    // inc paths can be directly passed from C code
-    std::string find_file(const std::string& file, const char* paths[])
-    {
-      if (paths == 0) return std::string("");
-      std::vector<std::string> includes(0);
-      // includes.push_back(".");
-      const char** it = paths;
-      while (it && *it) {
-        includes.push_back(*it);
-        ++it;
-      }
-      return find_file(file, includes);
-    }
-
     // try to load the given filename
     // returned memory must be freed
     // will auto convert .sass files
@@ -414,5 +430,25 @@ namespace Sass {
       }
     }
 
+    // split a path string delimited by semicolons or colons (OS dependent)
+    std::vector<std::string> split_path_list(const char* str)
+    {
+      std::vector<std::string> paths;
+      if (str == NULL) return paths;
+      // find delimiter via prelexer (return zero at end)
+      const char* end = Prelexer::find_first<PATH_SEP>(str);
+      // search until null delimiter
+      while (end) {
+        // add path from current position to delimiter
+        paths.push_back(std::string(str, end - str));
+        str = end + 1; // skip delimiter
+        end = Prelexer::find_first<PATH_SEP>(str);
+      }
+      // add path from current position to end
+      paths.push_back(std::string(str));
+      // return back
+      return paths;
+    }
+
   }
 }