C-API: Add call stack queries (functions and mixins) #2251

mgreter · 2016-12-18T03:01:38Z

Same as #2239 but rebased and adjusted after memory refactoring

mgreter · 2016-12-18T03:02:57Z

Fixes #1037 and #1950

Corresponding commits in perl-libsass:

Sample perl program

test.pl

use strict;
use warnings;

use CSS::Sass qw(get_callee_stack_size);
use CSS::Sass qw(get_callee_type);
use CSS::Sass qw(get_callee_name);
use CSS::Sass qw(get_callee_path);
use CSS::Sass qw(get_callee_line);
use CSS::Sass qw(get_callee_column);
use CSS::Sass qw(get_callee_var);
use CSS::Sass qw(set_callee_var);

my $sass = CSS::Sass->new(
  sass_functions => {
    'get-callee-stack-size()' => sub { get_callee_stack_size() },
    'get-callee-type($back : 0)' => sub { get_callee_type($_[0]) },
    'get-callee-name($back : 0)' => sub { get_callee_name($_[0]) },
    'get-callee-path($back : 0)' => sub { get_callee_path($_[0]) },
    'get-callee-line($back : 0)' => sub { get_callee_line($_[0]) },
    'get-callee-column($back : 0)' => sub { get_callee_column($_[0]) },
    'get-callee-var($name, $back : 0)' => sub { get_callee_var($_[0], $_[1]) },
    'set-callee-var($name, $val, $back : 0)' => sub { set_callee_var($_[0], $_[1], $_[2]) },
    'get-callee($back: 0)' => sub {
      return sprintf("(%d) %s at %s (%d/%d)",
        get_callee_type($_[0]),
        get_callee_name($_[0]),
        get_callee_path($_[0]),
        get_callee_line($_[0]),
        get_callee_column($_[0]),
      );
    }
  }
);

print $sass->compile_file("test.scss");

test.scss

@function baz($back: 0) {
  @return get-callee($back);
}

@function bar($back: 0) {
  @return baz($back);
}

@function foo($back: 0) {
  @return bar($back);
}

@mixin foo($back: 0) {
  @content;
}

A {
  $foo: "foo";
  @include foo {
    callee-5: foo(5);
    callee-4: foo(4);
    callee-3: foo(3);
    callee-2: foo(2);
    callee-1: foo(1);
    callee-0: foo(0);
    foo: get-callee-var("$foo");
    foo: set-callee-var("$foo", "new");
    foo: get-callee-var("$foo");
  }
}

result

A {
  callee-5: (0) foo at D:/.../perl-libsass/test.scss (19/12);
  callee-4: (0) @content at D:/.../perl-libsass/test.scss (14/3);
  callee-3: (1) foo at D:/.../perl-libsass/test.scss (21/15);
  callee-2: (1) bar at D:/.../perl-libsass/test.scss (10/11);
  callee-1: (1) baz at D:/.../perl-libsass/test.scss (6/11);
  callee-0: (2) get-callee at D:/.../perl-libsass/test.scss (2/11);
  foo: foo;
  foo: new; }

nschonni

My C/C++ is horrible, just read through as best I could

nschonni · 2016-12-28T22:35:04Z

src/context.cpp

@@ -87,8 +87,9 @@ namespace Sass {

  {

-    // add cwd to include paths
-    include_paths.push_back(CWD);
+    // Sass 3.4: The current working directory will no longer be placed onto the Sass load path by default.


Is it work wrapping in a complier directive for the SASS_LANG = 3.4?

Not sure. I was under the impression current master is going for 3.5. Side note: we could use a runtime test for 3.4 vs 3.5 behavior, but a compiler directive is not simple, since we have a string in that constant (string compare is not really supported by #if preprocessor directives).

Just realized that this change was done in ruby sass 3.4, not 3.5, therefore I think we should already have that removed. So to speak this is a bug in libsass 3.4. Or I did not get your comment?

You're right that this is 3.5 now, but I was thinking for ease of backporting changes to 3.4 while they are still both being maintained. I guess it would need to be a plain definition of SASS_LANGUAGE_3_4

I created a seperate commit for it, so it's better visible in this PR (for cherry-pick). IMO implementers are still free to add this on their own if the want to keep compatibility.

3.4 is stable, so no disruptive changes will back ported.

This is actually a bugfix as ruby sass 3.4 removed this behavior and we did not yet ...

I understand, however it's a breaking change and 3.4 is stable. The ship has sailed on breaking changes in 3.4. Back ports are only happening for small Sass fixes.

nschonni · 2016-12-28T22:37:36Z

src/file.hpp

@@ -113,7 +121,10 @@ namespace Sass {

  namespace File {

-    std::vector<Include> resolve_includes(const std::string& root, const std::string& file);
+    static std::vector<std::string> defaultExtensions = { ".scss", ".sass", ".css" };


Why include CSS files?

Same behavor as before, also see #754

You're right, but isn't it going away by 4 though? Might be another one to conditional out

IMO it should move into C-API to be configurable. This is just a small step in that direction.

nschonni · 2016-12-28T22:40:41Z

src/sass.cpp

+  char* ADDCALL sass_compiler_find_include (const char* file, struct Sass_Compiler* compiler)
+  {
+    // get the last import entry to get current base directory
+    // struct Sass_Options* options = sass_compiler_get_options(compiler);


Yep, commented due to unused var compiler warning.

nschonni · 2016-12-28T22:41:01Z

src/sass.cpp

+  char* ADDCALL sass_compiler_find_file (const char* file, struct Sass_Compiler* compiler)
+  {
+    // get the last import entry to get current base directory
+    // struct Sass_Options* options = sass_compiler_get_options(compiler);


Yep, commented due to unused var compiler warning.

mgreter · 2016-12-28T23:48:58Z

Needs a rebase after #2267 is merged!

mgreter · 2016-12-29T00:16:10Z

A few C-API remarks

The C-API has grown quite a bit and we now expose quite a few arrays. Implementation for them is often very different. Since the whole C-API is behind function calls and pointers now, we can use C++ behind those functions. Therefore we could just use std::vector instead of our own primitive implementations (as i.e. for include_paths, which is really a linked list in order to grow dynamically). But due to where we came from, most things on the C-API are still just structs (which are allocated via calloc and deleted via free). In order to support C++ containers, those structs need to be upgraded to real classes and allocated via new and freed via delete (otherwise we leak). So this task would basically boil down to design and implement a C++ API for LibSass (which would be a nice addon).

More CI tests (plugins)

I've added my libsass plugins to the CI process (Travis only so far). This allows most of the C-API to be tested via CI. I created a specific libsass-tests plugin to expose most C-API features as custom functions (work in progress). I was hoping to include a small sass-spec suite for each plugin, but unfortunately ran against sass/sass-spec#1025. So for now each plugin contains just one spec test that is run and compared via diff in libsass Travis CI.

For reference, these are the tested plugins:

*digest needs this PR to compile/work!

xzyfer · 2017-01-02T08:34:30Z

Hopefully this goes without saying but please don't start working on a C++ API before opening some RFCs to discuss the implementation and its goals.

- 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)

Sass 3.4: The current working directory will no longer be placed onto the Sass load path by default. If you need the current working directory to be available, set SASS_PATH=. in your shell's environment.

typoworx-de · 2019-08-07T09:16:34Z

How to use this in js using node-sass?

mgreter mentioned this pull request Dec 18, 2016

C-API: Add call stack queries (functions and mixins) #2239

Closed

mgreter changed the title ~~Feature/c api fn call stack~~ C-API: Add call stack queries (functions and mixins) Dec 18, 2016

mgreter added the C API label Dec 18, 2016

mgreter force-pushed the feature/c-api-fn-call-stack branch 2 times, most recently from b01e9ec to 1302cef Compare December 18, 2016 14:13

mgreter self-assigned this Dec 19, 2016

mgreter added the Dev - PR Ready label Dec 19, 2016

mgreter force-pushed the feature/c-api-fn-call-stack branch from 1302cef to 5be7c53 Compare December 19, 2016 14:12

mgreter force-pushed the feature/c-api-fn-call-stack branch 11 times, most recently from cc3c24e to a883321 Compare December 28, 2016 05:05

nschonni reviewed Dec 28, 2016

View reviewed changes

mgreter mentioned this pull request Dec 28, 2016

Adjust a few error messages and cleanups #2267

Merged

mgreter force-pushed the feature/c-api-fn-call-stack branch from a883321 to ba70025 Compare December 28, 2016 23:56

mgreter force-pushed the feature/c-api-fn-call-stack branch 5 times, most recently from 9d070e8 to a2be21d Compare December 29, 2016 03:33

mgreter force-pushed the feature/c-api-fn-call-stack branch from a2be21d to 5f9c8fe Compare January 2, 2017 15:55

mgreter added 6 commits January 5, 2017 14:46

Implements call stack queries (functions and mixins)

04d96da

Updates documentation for callee stack queries

c012fcb

Expose variable environments via C-API

8703ac3

Remove current working directory from search paths

12d8763

Sass 3.4: The current working directory will no longer be placed onto the Sass load path by default. If you need the current working directory to be available, set SASS_PATH=. in your shell's environment.

Add plugins to CI

5e21d3f

mgreter force-pushed the feature/c-api-fn-call-stack branch from 5f9c8fe to 5e21d3f Compare January 5, 2017 13:48

mgreter merged commit 1fc743c into sass:master Jan 5, 2017

This was referenced Jan 5, 2017

[FR] Expose ParserState of currently invoked function #1037

Closed

Accessing global Sass variables from within Sass functions written in JS #1950

Closed

mgreter mentioned this pull request Mar 10, 2017

C API: Import Handler - Get Path of File Containing @import Statement #2348

Closed

saper mentioned this pull request Oct 18, 2019

Accessing global Sass variables from within Sass functions written in JS sass/node-sass#1297

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

C-API: Add call stack queries (functions and mixins) #2251

C-API: Add call stack queries (functions and mixins) #2251

mgreter commented Dec 18, 2016

mgreter commented Dec 18, 2016

nschonni left a comment

nschonni Dec 28, 2016

mgreter Dec 28, 2016

mgreter Dec 29, 2016 •

edited

Loading

nschonni Dec 29, 2016

mgreter Dec 29, 2016

xzyfer Dec 29, 2016

mgreter Dec 29, 2016

xzyfer Dec 29, 2016

nschonni Dec 28, 2016

mgreter Dec 28, 2016 •

edited

Loading

nschonni Dec 29, 2016

mgreter Dec 29, 2016

nschonni Dec 28, 2016

mgreter Dec 28, 2016

nschonni Dec 28, 2016

mgreter Dec 28, 2016

mgreter commented Dec 28, 2016

mgreter commented Dec 29, 2016

xzyfer commented Jan 2, 2017

typoworx-de commented Aug 7, 2019

C-API: Add call stack queries (functions and mixins) #2251

C-API: Add call stack queries (functions and mixins) #2251

Conversation

mgreter commented Dec 18, 2016

mgreter commented Dec 18, 2016

Corresponding commits in perl-libsass:

Sample perl program

test.pl

test.scss

result

nschonni left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mgreter Dec 29, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mgreter Dec 28, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mgreter commented Dec 28, 2016

mgreter commented Dec 29, 2016

A few C-API remarks

More CI tests (plugins)

xzyfer commented Jan 2, 2017

typoworx-de commented Aug 7, 2019

mgreter Dec 29, 2016 •

edited

Loading

mgreter Dec 28, 2016 •

edited

Loading