ralsina/shortcode
1
0
Fork 0
Code Pull Requests Activity

return errors from parse() #1

Merged
ralsina merged 12 commits from return-errors into main 2023-07-14 01:05:13 +00:00
Conversation 0 Commits 12 Files Changed 6 +91 -63
3 changed files with 91 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 5350dbd126 - Show all commits

28
shortcodes.h
View File

@ -10,6 +10,14 @@ struct chunk
}; };
typedef struct chunk chunk; typedef struct chunk chunk;
// An error
struct sc_error
{
int position;
int code;
};
typedef struct sc_error sc_error;
// Describes a parsed shortcode // Describes a parsed shortcode
struct shortcode struct shortcode
{ {
@ -23,5 +31,23 @@ struct shortcode
}; };
typedef struct shortcode shortcode; typedef struct shortcode shortcode;
shortcode *parse(char *); struct sc_result
{
shortcode sc[100];
sc_error errors[10];
int errcount;
};
typedef struct sc_result sc_result;
// Error codes
/* You are closing the wrong shortcode.
Example:
{{% foo %}} {{% /bar %}}
*/
#define ERR_MISMATCHED_CLOSING_TAG 1
sc_result parse(char *);
#endif #endif

12
shortcodes.rl
View File

@ -1,7 +1,6 @@
#include <string.h> #include <string.h>
#include "shortcodes.h" #include "shortcodes.h"
%%{ %%{
machine shortcode; machine shortcode;
@ -94,7 +93,9 @@
start + sc_list[c_sc].name.start, start + sc_list[c_sc].name.start,
sc_list[c_sc-1].name.len) !=0) sc_list[c_sc-1].name.len) !=0)
{ {
return NULL; result.errors[result.errcount].position = p-start;
result.errors[result.errcount].code = ERR_MISMATCHED_CLOSING_TAG;
result.errcount++;
} }
// Reuse this shortcode entry for next one // Reuse this shortcode entry for next one
sc_list[c_sc].name.start = 0; sc_list[c_sc].name.start = 0;
@ -105,7 +106,7 @@
}%% }%%
shortcode *parse(char *input) { sc_result parse(char *input) {
%%write data; %%write data;
char *eof, *ts, *te = 0; char *eof, *ts, *te = 0;
@ -115,7 +116,8 @@ shortcode *parse(char *input) {
char *p = input; char *p = input;
char *pe = p + strlen(input); char *pe = p + strlen(input);
shortcode sc_list[1000]; sc_result result;
shortcode *sc_list = result.sc;
int c_sc = 0; int c_sc = 0;
int sc_start = 0; int sc_start = 0;
@ -127,5 +129,5 @@ shortcode *parse(char *input) {
%% write init; %% write init;
%% write exec; %% write exec;
return sc_list; return sc_result;
} }

112
tests.c
View File

@ -6,10 +6,11 @@ Describe(parse);
BeforeEach(parse) {} BeforeEach(parse) {}
AfterEach(parse) {} AfterEach(parse) {}
shortcode *result; sc_result result;
str s; str s;
chunk_s(char *buffer, chunk c){ chunk_s(char *buffer, chunk c)
{
str_copyb(&s, buffer + c.start, c.len); str_copyb(&s, buffer + c.start, c.len);
} }
@ -18,7 +19,7 @@ Ensure(parse, empty_string)
char *input = ""; char *input = "";
result = parse(input); result = parse(input);
// This means no shortcodes in it // This means no shortcodes in it
assert_that(result[0].name.len, is_equal_to(0)); assert_that(result.sc[0].name.len, is_equal_to(0));
} }
Ensure(parse, simple_shortcode) Ensure(parse, simple_shortcode)
@ -26,15 +27,15 @@ Ensure(parse, simple_shortcode)
char *input = "foobar {{% shortcode %}}blah"; char *input = "foobar {{% shortcode %}}blah";
result = parse(input); result = parse(input);
// Only 1 shortcode // Only 1 shortcode
assert_that(result[1].name.len, is_equal_to(0)); assert_that(result.sc[1].name.len, is_equal_to(0));
// It's a simple one called shortcode, no args // It's a simple one called shortcode, no args
chunk_s(input, result[0].name); chunk_s(input, result.sc[0].name);
assert_that(s.s, is_equal_to_string("shortcode")); assert_that(s.s, is_equal_to_string("shortcode"));
assert_that(result[0].matching, is_equal_to(0)); assert_that(result.sc[0].matching, is_equal_to(0));
assert_that(result[0].argcount, is_equal_to(0)); assert_that(result.sc[0].argcount, is_equal_to(0));
// The whole shortcode is the whole thing // The whole shortcode is the whole thing
chunk_s(input, result[0].whole); chunk_s(input, result.sc[0].whole);
assert_that(s.s, is_equal_to_string("{{% shortcode %}}")); assert_that(s.s, is_equal_to_string("{{% shortcode %}}"));
} }
@ -43,7 +44,7 @@ Ensure(parse, mismatched_brackets)
char *input = "foobar {{% shortcode >}}blah"; char *input = "foobar {{% shortcode >}}blah";
result = parse(input); result = parse(input);
// No shortcodes // No shortcodes
assert_that(result[0].name.len, is_equal_to(0)); assert_that(result.sc[0].name.len, is_equal_to(0));
} }
Ensure(parse, mismatched_brackets_inside_data_are_ok) Ensure(parse, mismatched_brackets_inside_data_are_ok)
@ -51,10 +52,10 @@ Ensure(parse, mismatched_brackets_inside_data_are_ok)
char *input = "foobar {{% sc %}} >}}blah {{% /sc %}} "; char *input = "foobar {{% sc %}} >}}blah {{% /sc %}} ";
result = parse(input); result = parse(input);
// 1 shortcode // 1 shortcode
assert_that(result[1].name.len, is_equal_to(0)); assert_that(result.sc[1].name.len, is_equal_to(0));
chunk_s(input, result[0].whole); chunk_s(input, result.sc[0].whole);
assert_that(s.s, is_equal_to_string("{{% sc %}} >}}blah {{% /sc %}}")); assert_that(s.s, is_equal_to_string("{{% sc %}} >}}blah {{% /sc %}}"));
chunk_s(input, result[0].data); chunk_s(input, result.sc[0].data);
assert_that(s.s, is_equal_to_string(" >}}blah ")); assert_that(s.s, is_equal_to_string(" >}}blah "));
} }
@ -63,10 +64,10 @@ Ensure(parse, mismatched_brackets_in_qval_are_ok)
char *input = "foobar {{% sc \">}}blah\" %}} {{% /sc %}}"; char *input = "foobar {{% sc \">}}blah\" %}} {{% /sc %}}";
result = parse(input); result = parse(input);
// 1 shortcode // 1 shortcode
assert_that(result[1].name.len, is_equal_to(0)); assert_that(result.sc[1].name.len, is_equal_to(0));
chunk_s(input, result[0].whole); chunk_s(input, result.sc[0].whole);
assert_that(s.s, is_equal_to_string("{{% sc \">}}blah\" %}} {{% /sc %}}")); assert_that(s.s, is_equal_to_string("{{% sc \">}}blah\" %}} {{% /sc %}}"));
chunk_s(input, result[0].argvals[0]); chunk_s(input, result.sc[0].argvals[0]);
assert_that(s.s, is_equal_to_string(">}}blah")); assert_that(s.s, is_equal_to_string(">}}blah"));
} }
@ -75,15 +76,15 @@ Ensure(parse, inner_spaces_optional)
char *input = "foobar {{% shortcode%}}blah"; char *input = "foobar {{% shortcode%}}blah";
result = parse(input); result = parse(input);
// Only 1 shortcode // Only 1 shortcode
assert_that(result[1].name.len, is_equal_to(0)); assert_that(result.sc[1].name.len, is_equal_to(0));
// It's a simple one called shortcode, no args // It's a simple one called shortcode, no args
chunk_s(input, result[0].name); chunk_s(input, result.sc[0].name);
assert_that(s.s, is_equal_to_string("shortcode")); assert_that(s.s, is_equal_to_string("shortcode"));
assert_that(result[0].matching, is_equal_to(0)); assert_that(result.sc[0].matching, is_equal_to(0));
assert_that(result[0].argcount, is_equal_to(0)); assert_that(result.sc[0].argcount, is_equal_to(0));
// The whole shortcode is the whole thing // The whole shortcode is the whole thing
chunk_s(input, result[0].whole); chunk_s(input, result.sc[0].whole);
assert_that(s.s, is_equal_to_string("{{% shortcode%}}")); assert_that(s.s, is_equal_to_string("{{% shortcode%}}"));
} }
@ -92,13 +93,13 @@ Ensure(parse, name_can_be_path)
char *input = "foobar {{% shortcode/foo/bar %}}blah"; char *input = "foobar {{% shortcode/foo/bar %}}blah";
result = parse(input); result = parse(input);
// Only 1 shortcode // Only 1 shortcode
assert_that(result[1].name.len, is_equal_to(0)); assert_that(result.sc[1].name.len, is_equal_to(0));
// It's a simple one called shortcode, no args // It's a simple one called shortcode, no args
chunk_s(input, result[0].name); chunk_s(input, result.sc[0].name);
assert_that(s.s, is_equal_to_string("shortcode/foo/bar")); assert_that(s.s, is_equal_to_string("shortcode/foo/bar"));
assert_that(result[0].matching, is_equal_to(0)); assert_that(result.sc[0].matching, is_equal_to(0));
assert_that(result[0].argcount, is_equal_to(0)); assert_that(result.sc[0].argcount, is_equal_to(0));
} }
Ensure(parse, multiple_shortcodes) Ensure(parse, multiple_shortcodes)
@ -106,23 +107,23 @@ Ensure(parse, multiple_shortcodes)
char *input = "foobar {{% shortcode %}}blah {{<sc2 >}}blahblah"; char *input = "foobar {{% shortcode %}}blah {{<sc2 >}}blahblah";
result = parse(input); result = parse(input);
// 2 shortcodes // 2 shortcodes
assert_that(result[2].name.len, is_equal_to(0)); assert_that(result.sc[2].name.len, is_equal_to(0));
// It's a simple one called shortcode, no args // It's a simple one called shortcode, no args
chunk_s(input, result[0].name); chunk_s(input, result.sc[0].name);
assert_that(s.s, is_equal_to_string("shortcode")); assert_that(s.s, is_equal_to_string("shortcode"));
assert_that(result[0].matching, is_equal_to(0)); assert_that(result.sc[0].matching, is_equal_to(0));
assert_that(result[0].argcount, is_equal_to(0)); assert_that(result.sc[0].argcount, is_equal_to(0));
// The whole shortcode is the whole thing // The whole shortcode is the whole thing
chunk_s(input, result[0].whole); chunk_s(input, result.sc[0].whole);
assert_that(s.s, is_equal_to_string("{{% shortcode %}}")); assert_that(s.s, is_equal_to_string("{{% shortcode %}}"));
// It's a simple one called sc2, no args // It's a simple one called sc2, no args
chunk_s(input, result[1].name); chunk_s(input, result.sc[1].name);
assert_that(s.s, is_equal_to_string("sc2")); assert_that(s.s, is_equal_to_string("sc2"));
assert_that(result[1].matching, is_equal_to(0)); assert_that(result.sc[1].matching, is_equal_to(0));
assert_that(result[1].argcount, is_equal_to(0)); assert_that(result.sc[1].argcount, is_equal_to(0));
// The whole shortcode is the whole thing // The whole shortcode is the whole thing
chunk_s(input, result[1].whole); chunk_s(input, result.sc[1].whole);
assert_that(s.s, is_equal_to_string("{{<sc2 >}}")); assert_that(s.s, is_equal_to_string("{{<sc2 >}}"));
} }
@ -132,18 +133,18 @@ Ensure(parse, matching_shortcode)
result = parse(input); result = parse(input);
// Only 1 shortcode // Only 1 shortcode
assert_that(result[1].name.len, is_equal_to(0)); assert_that(result.sc[1].name.len, is_equal_to(0));
// It's a matching one called shortcode, no args // It's a matching one called shortcode, no args
chunk_s(input, result[0].name); chunk_s(input, result.sc[0].name);
assert_that(s.s, is_equal_to_string("shortcode")); assert_that(s.s, is_equal_to_string("shortcode"));
assert_that(result[0].matching, is_equal_to(1)); assert_that(result.sc[0].matching, is_equal_to(1));
assert_that(result[0].argcount, is_equal_to(0)); assert_that(result.sc[0].argcount, is_equal_to(0));
// data is the stuff between the shortcode tags // data is the stuff between the shortcode tags
chunk_s(input, result[0].data); chunk_s(input, result.sc[0].data);
assert_that(s.s, is_equal_to_string("foo bar")); assert_that(s.s, is_equal_to_string("foo bar"));
// The whole shortcode is the whole thing // The whole shortcode is the whole thing
chunk_s(input, result[0].whole); chunk_s(input, result.sc[0].whole);
assert_that(s.s, is_equal_to_string("{{% shortcode %}}foo bar{{% /shortcode %}}")); assert_that(s.s, is_equal_to_string("{{% shortcode %}}foo bar{{% /shortcode %}}"));
} }
@ -152,41 +153,41 @@ Ensure(parse, shortcode_args)
char *input = "foobar {{% shortcode foo \"bar\" 42 bat=v1 baz=\"v2\" %}}blah"; char *input = "foobar {{% shortcode foo \"bar\" 42 bat=v1 baz=\"v2\" %}}blah";
result = parse(input); result = parse(input);
// Only 1 shortcode // Only 1 shortcode
assert_that(result[1].name.len, is_equal_to(0)); assert_that(result.sc[1].name.len, is_equal_to(0));
// The whole shortcode is the whole thing // The whole shortcode is the whole thing
chunk_s(input, result[0].whole); chunk_s(input, result.sc[0].whole);
assert_that(s.s, is_equal_to_string("{{% shortcode foo \"bar\" 42 bat=v1 baz=\"v2\" %}}")); assert_that(s.s, is_equal_to_string("{{% shortcode foo \"bar\" 42 bat=v1 baz=\"v2\" %}}"));
// Name is shortcode // Name is shortcode
chunk_s(input, result[0].name); chunk_s(input, result.sc[0].name);
assert_that(s.s, is_equal_to_string("shortcode")); assert_that(s.s, is_equal_to_string("shortcode"));
assert_that(result[0].matching, is_equal_to(0)); assert_that(result.sc[0].matching, is_equal_to(0));
// Has 5 args // Has 5 args
assert_that(result[0].argcount, is_equal_to(5)); assert_that(result.sc[0].argcount, is_equal_to(5));
// Arg1 is foo, no name // Arg1 is foo, no name
assert_that(result[0].argnames[0].len, is_equal_to(0)); assert_that(result.sc[0].argnames[0].len, is_equal_to(0));
chunk_s(input, result[0].argvals[0]); chunk_s(input, result.sc[0].argvals[0]);
assert_that(s.s, is_equal_to_string("foo")); assert_that(s.s, is_equal_to_string("foo"));
// Arg2 is bar, no name // Arg2 is bar, no name
assert_that(result[0].argnames[1].len, is_equal_to(0)); assert_that(result.sc[0].argnames[1].len, is_equal_to(0));
chunk_s(input, result[0].argvals[1]); chunk_s(input, result.sc[0].argvals[1]);
assert_that(s.s, is_equal_to_string("bar")); assert_that(s.s, is_equal_to_string("bar"));
// Arg3 is 42, no name // Arg3 is 42, no name
assert_that(result[0].argnames[2].len, is_equal_to(0)); assert_that(result.sc[0].argnames[2].len, is_equal_to(0));
chunk_s(input, result[0].argvals[2]); chunk_s(input, result.sc[0].argvals[2]);
assert_that(s.s, is_equal_to_string("42")); assert_that(s.s, is_equal_to_string("42"));
// Arg4 is bat=v1 // Arg4 is bat=v1
chunk_s(input, result[0].argnames[3]); chunk_s(input, result.sc[0].argnames[3]);
assert_that(s.s, is_equal_to_string("bat")); assert_that(s.s, is_equal_to_string("bat"));
chunk_s(input, result[0].argvals[3]); chunk_s(input, result.sc[0].argvals[3]);
assert_that(s.s, is_equal_to_string("v1")); assert_that(s.s, is_equal_to_string("v1"));
// Arg5 is baz=v2 // Arg5 is baz=v2
chunk_s(input, result[0].argnames[4]); chunk_s(input, result.sc[0].argnames[4]);
assert_that(s.s, is_equal_to_string("baz")); assert_that(s.s, is_equal_to_string("baz"));
chunk_s(input, result[0].argvals[4]); chunk_s(input, result.sc[0].argvals[4]);
assert_that(s.s, is_equal_to_string("v2")); assert_that(s.s, is_equal_to_string("v2"));
} }
@ -195,10 +196,9 @@ Ensure(parse, escaped_shortcode)
char *input = "foobar \\{{% shortcode %}}"; char *input = "foobar \\{{% shortcode %}}";
result = parse(input); result = parse(input);
// No shortcodes // No shortcodes
assert_that(result[0].name.len, is_equal_to(0)); assert_that(result.sc[0].name.len, is_equal_to(0));
} }
int main(int argc, char **argv) int main(int argc, char **argv)
{ {
str_init(&s); str_init(&s);