diff --git a/README.md b/README.md index 0f771c0..7f0cd94 100644 --- a/README.md +++ b/README.md @@ -55,11 +55,11 @@ html_t hello_world() // ^^^ functions that return content to be rendered // must return the html_t or char* types - html_t tmp = malloc(128 * sizeof(char)); + html_t tmp; // ^^^ you don't need to free this malloc, // the framework will do it for you. - sprintf(tmp, "%s", "Hello, World!"); + asprintf(&tmp, "%s", "Hello, World!"); // ^^^ this works because html_t expands // to char* @@ -96,7 +96,7 @@ To test the project, run: `tapm run`. Navigating to `http://127.0.0.1:4000` in y ![getting-started-1](https://i.imgur.com/zGWqSow.png) -For a more complex example, view the project in the `example/` folder of the repo! +For more complex examples, view the project in the `examples/` folder of the repo! ## Appendix @@ -129,13 +129,20 @@ html_t html = HTML( ); ``` -### Building from source +...or: -The root level `Makefile` was designed for POSIX-compliant systems — `tapm build` will not work on Windows outside of WSL. - -### Binding a C function to a DOM event - -![binding-a-c-function-to-a-dom-event](https://camo.githubusercontent.com/339f5dbb4a8a9945034f5b1ba5efc7e5e2780a5353361c2fbea52b5ae47c7c4b/68747470733a2f2f692e696d6775722e636f6d2f6c766e6f646e442e676966) +``` +html_t html = HTMLIFY(" \ +
\ +

${hello_world()}$

\ +
\ + \ +"); +``` ### Returning other types as `html_t` @@ -143,10 +150,9 @@ The root level `Makefile` was designed for POSIX-compliant systems — `tapm bui EMSCRIPTEN_KEEPALIVE html_t add_two_numbers(int a, int b) { - char *tmp = malloc(128 * sizeof(int)); + char *tmp; int result = a + b; - sprintf(tmp, "%d", result); - html_t expands to char* + asprintf(&tmp, "%d", result); return tmp; } ``` @@ -164,20 +170,6 @@ html_t hello_world() ``` ... would also work. Thing is, it is not the best because the framework will try to free a pointer that wasn't malloc-ed. While this doesn't cause an error, I wouldn't call it a best practice. -### Are you updating HTML you've already rendered? - -If that's the case, you must remove the old html before you update your state. For example, when updating the counter in `example/src/hello_world.c`, I do: - -```C -EMSCRIPTEN_KEEPALIVE -void increase_counter() -{ - remove_html(main_h); - counter++; - display_html(main_h); -} -``` - ### Notes to Self To check for any problems (i.e., mem leaks and whatnot) in the code at runtime, compile like so: `emcc hello_world.c ../../src/dcw.c --js-library ../../src/dcw.js -fsanitize=address -s ALLOW_MEMORY_GROWTH -s INITIAL_MEMORY=285212672 -gsource-map --source-map-base http://127.0.0.1:4000`. After that, run with: `tapm run`. diff --git a/Tarantella.toml b/Tarantella.toml index 7f5e228..8004d1e 100644 --- a/Tarantella.toml +++ b/Tarantella.toml @@ -1,6 +1,6 @@ [package] name = "dcw" -version = "0.4.0" # format: major.minor.patch +version = "0.5.0" # format: major.minor.patch module_type = "side_module" # main_module || side_module build_dir = "build" # when modifying this field, change BUILD_DIR in the Makefile too releases_repo = "https://github.com/danbugs/dancing_web" # format: https://github.com// diff --git a/docs/dcw_8c.html b/docs/dcw_8c.html index 4f2832a..4d7ba53 100644 --- a/docs/dcw_8c.html +++ b/docs/dcw_8c.html @@ -70,7 +70,6 @@
-Macros | Functions | Variables
@@ -84,43 +83,56 @@ #include <stdio.h>
#include <stdlib.h>
#include <string.h>
+#include <stdbool.h>
#include "error.cml"
Include dependency graph for dcw.c:
- - - - - - - - - + + + + + + + + + +
- - - -

-Macros

#define dbg(to_print, formatter)
 
- - + + + + + + + + - - + + + + + + + + + + + +

Functions

void displayInner (html_t html)
 
void removeInner (html_t html)
 
void removeStaticInner (html_t html)
 
void removeWithClassInner (char *class_name)
 
void removeChildrenOfIdInner (char *id)
 
void insertAtIdInner (html_t html, char *id)
 
html_t parse_html_wrapper (parse_html_args in)
 
html_t parse_html_core (html_t raw_html, marker_t marker)
 
EMSCRIPTEN_KEEPALIVE void display_html (html_t raw_html)
 
EMSCRIPTEN_KEEPALIVE void remove_html (html_t raw_html)
 
EMSCRIPTEN_KEEPALIVE void remove_static_html (html_t raw_html)
 
EMSCRIPTEN_KEEPALIVE void remove_html_with_class (char *class_name)
 
EMSCRIPTEN_KEEPALIVE void display_html_loop (html_t html_formatter, char **elements, int num_elements, bool reverse)
 
EMSCRIPTEN_KEEPALIVE html_t render_html_loop (html_t html_formatter, char **elements, int num_elements, bool reverse)
 
EMSCRIPTEN_KEEPALIVE void remove_html_children_of_id (char *id)
 
EMSCRIPTEN_KEEPALIVE void insert_html_at_id (html_t raw_html, char *id)
 
@@ -129,24 +141,61 @@

Variables

Detailed Description

A framework to write HTML directly within C and have it call C functions. Users interact with it through the display_html and remove_html functions, and the html_t and HTML macros in dcw.h.

-

Macro Definition Documentation

- -

◆ dbg

+

Function Documentation

+ +

◆ display_html()

- + - - + + + + +
#define dbgEMSCRIPTEN_KEEPALIVE void display_html ( to_print, html_t raw_html)
+
+

A wrapper for parse_html, and the JS funtion displayInner .

+
Parameters
+ + +
raw_htmlThe HTML you want to display. This should be of type html_t or char*.
+
+
+ +
+
+ +

◆ display_html_loop()

+ +
+
+ + + + + + + + + + + + - - + + + + + + + + @@ -155,58 +204,108 @@

-Value:
{ \
-
printf(#to_print ": " #formatter "\n", to_print); \
-
}
-

A utility function for easy debug. It prints the variable name and its' value. Usage: char *hello_world = "Hello, World!"; dbg(hello_world, d);

-

Output: "hello_world: Hello, World!"

+

Displays a char** as HTML inside a specific HTML formatter.

+
Parameters
+

EMSCRIPTEN_KEEPALIVE void display_html_loop (html_t html_formatter,
char ** elements,
 formatter int num_elements,
bool reverse 
+ + + + +
html_formatterWhere each element of your char** will be rendered (e.g., "<p>%s</p>") - use normal C formatters.
elementsThe array you want to render.
num_elementsThe number of elements of the elements array.
reverseIf true , the array will be rendered in reverse. or char*.
+ +
-

Function Documentation

- -

◆ display_html()

+ +

◆ displayInner()

- + - +
EMSCRIPTEN_KEEPALIVE void display_html void displayInner ( html_t raw_html)html)
-

A wrapper for parse_html, and the JS funtion displayInner .

+

A JS funtion that renders the HTML to the DOM.

Parameters
+ + +
htmlThe HTML you want to render. This should be of type html_t or char*.
+
+
+ +
+
+ +

◆ insert_html_at_id()

+ +
+
+ + + + + + + + + + + + + + + + + + +
EMSCRIPTEN_KEEPALIVE void insert_html_at_id (html_t raw_html,
char * id 
)
+
+

A wrapper for parse_html, and the JS funtion insertAtIdInner .

Parameters
+
raw_htmlThe HTML you want to display. This should be of type html_t or char*.
idThe ID where you want to insert the parsed HTML at.
- -

◆ displayInner()

+ +

◆ insertAtIdInner()

- + - + + + + + + + + + + +
void displayInner void insertAtIdInner ( html_t html)html,
char * id 
)
-

A JS funtion that renders the HTML to the DOM.

Parameters
+

A JS funtion that renders the HTML to the DOM at a specific ID.

Parameters
+
htmlThe HTML you want to render. This should be of type html_t or char*.
idThe id of the HTML you want to render.
@@ -273,14 +372,64 @@

-

◆ remove_html()

+ +

◆ remove_html_children_of_id()

+ +
+
+ + + + + + + + +
EMSCRIPTEN_KEEPALIVE void remove_html_children_of_id (char * id)
+
+

A wrapper for the JS funtion removeChildrenOfIdInner .

+
Parameters
+ + +
class_nameThe id of the HTML you want to remove the children of. This should be of type html_t or char*.
+
+
+ +
+
+ +

◆ remove_html_with_class()

- + + + + + + +
EMSCRIPTEN_KEEPALIVE void remove_html EMSCRIPTEN_KEEPALIVE void remove_html_with_class (char * class_name)
+
+

A wrapper for the JS funtion removeWithClassInner .

+
Parameters
+ + +
class_nameThe class of the HTML you want to remove. This should be of type html_t or char*.
+
+
+ +
+
+ +

◆ remove_static_html()

+ +
+
+ + + @@ -288,7 +437,7 @@

-

A wrapper for parse_html, and the JS funtion removeInner .

+

A wrapper for parse_html, and the JS funtion removeStaticInner .

Parameters

EMSCRIPTEN_KEEPALIVE void remove_static_html ( html_t  raw_html)
@@ -298,14 +447,38 @@

-

◆ removeInner()

+ +

◆ removeChildrenOfIdInner()

+ +
+
+
raw_htmlThe HTML you want to remove. This should be of type html_t or char*.
+ + + + + + + +
void removeChildrenOfIdInner (char * id)
+
+

A JS funtion that removes the children of an HTML node with a specific ID.

Parameters
+ + +
htmlThe ID of the parent HTML.
+
+
+ +
+
+ +

◆ removeStaticInner()

- + @@ -313,13 +486,88 @@

-

A JS funtion that removes HTML from the DOM.

Parameters
+

A JS funtion that removes static HTML from the DOM.

Parameters

void removeInner void removeStaticInner ( html_t  html)
htmlThe HTML you want to remove. This should be of type html_t or char*.

+
+
+ +

◆ removeWithClassInner()

+ +
+
+ + + + + + + + +
void removeWithClassInner (char * class_name)
+
+

A JS funtion that removes HTML from the DOM with a specific class.

Parameters
+ + +
htmlThe class of the HTML you want to remove.
+
+
+ +
+
+ +

◆ render_html_loop()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EMSCRIPTEN_KEEPALIVE html_t render_html_loop (html_t html_formatter,
char ** elements,
int num_elements,
bool reverse 
)
+
+

Renders a char** as HTML inside a specific HTML formatter.

+
Parameters
+ + + + + +
html_formatterWhere each element of your char** will be rendered (e.g., "<p>%s</p>") - use normal C formatters.
elementsThe array you want to render.
num_elementsThe number of elements of the elements array.
reverseIf true , the array will be rendered in reverse.
+
+
+
Returns
The rendered HTML that can be inserted into any part of the DOM. or char*.
+

Variable Documentation

@@ -335,7 +583,7 @@

Initial value:
=
-
# 31 "/mnt/c/Users/danil/source/repos/dancing_web/src/dcw.c" 2
+
# 32 "/mnt/c/Users/danil/source/repos/dancing_web/src/dcw.c" 2

The HTML that is displayed to the users then there is DCW encounters an error.

diff --git a/docs/dcw_8c__incl.map b/docs/dcw_8c__incl.map index 55e55c0..4481b0b 100644 --- a/docs/dcw_8c__incl.map +++ b/docs/dcw_8c__incl.map @@ -1,11 +1,12 @@ - - - - - - - - - - - + + + + + + + + + + + + diff --git a/docs/dcw_8c__incl.md5 b/docs/dcw_8c__incl.md5 index 3383d7c..93fad17 100644 --- a/docs/dcw_8c__incl.md5 +++ b/docs/dcw_8c__incl.md5 @@ -1 +1 @@ -5ce12cf315bdc2fd53b0abe1d271605e \ No newline at end of file +a660977b8c4d102b08b7bf46ef82af80 \ No newline at end of file diff --git a/docs/dcw_8c__incl.png b/docs/dcw_8c__incl.png index b299d4c..821af52 100644 Binary files a/docs/dcw_8c__incl.png and b/docs/dcw_8c__incl.png differ diff --git a/docs/dcw_8h.html b/docs/dcw_8h.html index 40fb687..58e9ca2 100644 --- a/docs/dcw_8h.html +++ b/docs/dcw_8h.html @@ -92,12 +92,50 @@ Macros

#define html_t   char *   -#define HTML(...)   #__VA_ARGS__; +#define HTML(...)   #__VA_ARGS__   + +#define HTMLIFY(str)   (html_t) str +  +#define dbg(to_print, formatter) + 

Detailed Description

Useful macros intended to be used by the end-user.

Macro Definition Documentation

+ +

◆ dbg

+ +
+
+ + + + + + + + + + + + + + + + + + +
#define dbg( to_print,
 formatter 
)
+
+Value:
{ \
+
printf(#to_print ": " #formatter "\n", to_print); \
+
}
+

A utility function for easy debug. It prints the variable name and its' value. Usage: char *hello_world = "Hello, World!"; dbg(hello_world, d);

+

Output: "hello_world: Hello, World!"

+ +
+

◆ HTML

@@ -109,7 +147,7 @@

  ...) -    #__VA_ARGS__; +    #__VA_ARGS__
diff --git a/docs/dcw_8h_source.html b/docs/dcw_8h_source.html index ad79a00..7eb2f0e 100644 --- a/docs/dcw_8h_source.html +++ b/docs/dcw_8h_source.html @@ -73,21 +73,27 @@
dcw.h
-Go to the documentation of this file.
1 #pragma once
-
2 
-
6 /*
-
7  * Copyright 2021 Danilo Chiarlone
-
8  * LICENSE: GNU AFFERO GENERAL PUBLIC LICENSE
-
9 */
-
10 
-
13 #define html_t char *
-
14 
-
17 #define HTML(...) #__VA_ARGS__;
-
18 
-
27 #define dbg(to_print, formatter) \
-
28  { \
-
29  printf(#to_print ": " #formatter "\n", to_print); \
-
30  }
+Go to the documentation of this file.
1 
+
5 /*
+
6  * Copyright 2021 Danilo Chiarlone
+
7  * LICENSE: GNU AFFERO GENERAL PUBLIC LICENSE
+
8 */
+
9 
+
10 #ifndef DCW_H
+
11 #define DCW_H
+
12 
+
15 #define html_t char *
+
16 
+
19 #define HTML(...) #__VA_ARGS__
+
20 
+
21 #define HTMLIFY(str) (html_t) str
+
22 
+
31 #define dbg(to_print, formatter) \
+
32  { \
+
33  printf(#to_print ": " #formatter "\n", to_print); \
+
34  }
+
35 
+
36 #endif
diff --git a/docs/dcw__internal_8h_source.html b/docs/dcw__internal_8h_source.html index c7ba504..91fe886 100644 --- a/docs/dcw__internal_8h_source.html +++ b/docs/dcw__internal_8h_source.html @@ -74,48 +74,51 @@
Go to the documentation of this file.
1 
-
5 #include "dcw.h"
-
6 
-
11 enum marker_type
-
12 {
-
13  RENDERABLE_MARKERS,
-
14  EXECUTABLE_MARKERS,
-
15 };
-
16 
-
20 typedef struct
-
21 {
-
22  char expression[20]; // maximum 20 chars (using this instead of char* to avoid a null-pointer-dereference)
-
23  enum marker_type type;
-
24  int size;
-
25  int front_size;
-
26  int back_size;
-
27  int eval_increment;
-
28  // ^ how many characters we need to add to the expression when evaluated
-
29  // (i.e., 1 for RENDERABLE_MARKERS due to the '_' , and 8 for EXECUTABLE_MARKERS due to the 'Module._')
-
30 } marker_t;
-
31 
-
35 typedef struct
-
36 {
-
37  html_t raw_html;
-
38  enum marker_type marker;
-
39 } parse_html_args;
-
40 
-
44 #define parse_html(...) parse_html_wrapper((parse_html_args){__VA_ARGS__});
-
45 
-
46 html_t parse_html_wrapper(parse_html_args in);
-
47 
-
48 html_t parse_html_core(html_t raw_html, marker_t marker);
-
49 
-
50 void display_html(html_t raw_html);
+
4 #ifndef DCW_INTERNAL_H
+
5 #define DCW_INTERNAL_H
+
6 #include "dcw.h"
+
7 
+
12 enum marker_type
+
13 {
+
14  RENDERABLE_MARKERS,
+
15  EXECUTABLE_MARKERS,
+
16 };
+
17 
+
21 typedef struct
+
22 {
+
23  char expression[20]; // maximum 20 chars (using this instead of char* to avoid a null-pointer-dereference)
+
24  enum marker_type type;
+
25  int size;
+
26  int front_size;
+
27  int back_size;
+
28  int eval_increment;
+
29  // ^ how many characters we need to add to the expression when evaluated
+
30  // (i.e., 1 for RENDERABLE_MARKERS due to the '_' , and 8 for EXECUTABLE_MARKERS due to the 'Module._')
+
31 } marker_t;
+
32 
+
36 typedef struct
+
37 {
+
38  html_t raw_html;
+
39  enum marker_type marker;
+
40 } parse_html_args;
+
41 
+
45 #define parse_html(...) parse_html_wrapper((parse_html_args){__VA_ARGS__});
+
46 
+
47 html_t parse_html_wrapper(parse_html_args in);
+
48 
+
49 html_t parse_html_core(html_t raw_html, marker_t marker);
+
50 
+
51 void display_html(html_t raw_html);
+
52 #endif
-
parse_html_core
html_t parse_html_core(html_t raw_html, marker_t marker)
Definition: dcw.c:79
-
parse_html_args
Definition: dcw_internal.h:35
-
marker_type
marker_type
Definition: dcw_internal.h:11
+
parse_html_core
html_t parse_html_core(html_t raw_html, marker_t marker)
Definition: dcw.c:98
+
parse_html_args
Definition: dcw_internal.h:36
+
marker_type
marker_type
Definition: dcw_internal.h:12
-
parse_html_wrapper
html_t parse_html_wrapper(parse_html_args in)
Definition: dcw.c:48
-
html_t
#define html_t
Definition: dcw.h:13
-
display_html
void display_html(html_t raw_html)
Definition: dcw.c:148
-
marker_t
Definition: dcw_internal.h:20
+
parse_html_wrapper
html_t parse_html_wrapper(parse_html_args in)
Definition: dcw.c:66
+
html_t
#define html_t
Definition: dcw.h:15
+
display_html
void display_html(html_t raw_html)
Definition: dcw.c:167
+
marker_t
Definition: dcw_internal.h:21
Generated by   diff --git a/docs/globals.html b/docs/globals.html index 262e89d..6cad13a 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -67,12 +67,15 @@
Here is a list of all documented file members with links to the documentation:
diff --git a/docs/globals_defs.html b/docs/globals_defs.html index ee87647..99b29c8 100644 --- a/docs/globals_defs.html +++ b/docs/globals_defs.html @@ -67,7 +67,7 @@
 
  • dbg -: dcw.c +: dcw.h
  • HTML : dcw.h diff --git a/docs/globals_func.html b/docs/globals_func.html index ad07369..1299b9e 100644 --- a/docs/globals_func.html +++ b/docs/globals_func.html @@ -70,9 +70,18 @@ : dcw.c , dcw_internal.h
    • +
  • display_html_loop() +: dcw.c +
  • displayInner() : dcw.c
    • +
  • insert_html_at_id() +: dcw.c +
    • +
  • insertAtIdInner() +: dcw.c +
  • parse_html_core() : dcw.c , dcw_internal.h @@ -81,11 +90,26 @@ : dcw.c , dcw_internal.h
    • -
  • remove_html() -: dcw.c +
  • remove_html_children_of_id() +: dcw.c +
    • +
  • remove_html_with_class() +: dcw.c +
    • +
  • remove_static_html() +: dcw.c +
    • +
  • removeChildrenOfIdInner() +: dcw.c +
    • +
  • removeStaticInner() +: dcw.c +
    • +
  • removeWithClassInner() +: dcw.c
    • -
  • removeInner() -: dcw.c +
  • render_html_loop() +: dcw.c
diff --git a/docs/search/all_0.js b/docs/search/all_0.js index 5080d17..5c056af 100644 --- a/docs/search/all_0.js +++ b/docs/search/all_0.js @@ -1,9 +1,10 @@ var searchData= [ - ['dbg_0',['dbg',['../dcw_8c.html#ad7bacf2541029a8abefd4b8fd5e47884',1,'dcw.h']]], + ['dbg_0',['dbg',['../dcw_8h.html#ad7bacf2541029a8abefd4b8fd5e47884',1,'dcw.h']]], ['dcw_2ec_1',['dcw.c',['../dcw_8c.html',1,'']]], ['dcw_2eh_2',['dcw.h',['../dcw_8h.html',1,'']]], ['dcw_5finternal_2eh_3',['dcw_internal.h',['../dcw__internal_8h.html',1,'']]], ['display_5fhtml_4',['display_html',['../dcw_8c.html#a236b6784517212c4a78be8b8db9b145b',1,'display_html(html_t raw_html): dcw.c'],['../dcw__internal_8h.html#acf9b4ce1e6add7b81ac2a3791fe25e1c',1,'display_html(html_t raw_html): dcw.c']]], - ['displayinner_5',['displayInner',['../dcw_8c.html#a8bad87084459d4b6a23cf22a7d706d31',1,'dcw.c']]] + ['display_5fhtml_5floop_5',['display_html_loop',['../dcw_8c.html#ab627a4f2281dbf80f07e19f0f6d25270',1,'dcw.c']]], + ['displayinner_6',['displayInner',['../dcw_8c.html#a8bad87084459d4b6a23cf22a7d706d31',1,'dcw.c']]] ]; diff --git a/docs/search/all_1.js b/docs/search/all_1.js index 2bc8836..58ad51f 100644 --- a/docs/search/all_1.js +++ b/docs/search/all_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['error_5fhtml_6',['ERROR_HTML',['../dcw_8c.html#a426faf00e00772908cbebc65fe487bd8',1,'dcw.c']]] + ['error_5fhtml_7',['ERROR_HTML',['../dcw_8c.html#a426faf00e00772908cbebc65fe487bd8',1,'dcw.c']]] ]; diff --git a/docs/search/all_2.js b/docs/search/all_2.js index e17e9c3..202159f 100644 --- a/docs/search/all_2.js +++ b/docs/search/all_2.js @@ -1,5 +1,5 @@ var searchData= [ - ['html_7',['HTML',['../dcw_8h.html#adb7919934cdf0c9f8d1a017e77cd1b47',1,'dcw.h']]], - ['html_5ft_8',['html_t',['../dcw_8h.html#af567bc1a447b57bc4f446b93f5a3e8d2',1,'dcw.h']]] + ['html_8',['HTML',['../dcw_8h.html#adb7919934cdf0c9f8d1a017e77cd1b47',1,'dcw.h']]], + ['html_5ft_9',['html_t',['../dcw_8h.html#af567bc1a447b57bc4f446b93f5a3e8d2',1,'dcw.h']]] ]; diff --git a/docs/search/all_3.js b/docs/search/all_3.js index 39bb65f..4587a49 100644 --- a/docs/search/all_3.js +++ b/docs/search/all_3.js @@ -1,5 +1,5 @@ var searchData= [ - ['marker_5ft_9',['marker_t',['../structmarker__t.html',1,'']]], - ['marker_5ftype_10',['marker_type',['../dcw__internal_8h.html#a12f1ea9cb1decaed2f0c35213be6e7db',1,'dcw_internal.h']]] + ['insert_5fhtml_5fat_5fid_10',['insert_html_at_id',['../dcw_8c.html#aa9b20ce7dfa34677289d4c3ce971c6e6',1,'dcw.c']]], + ['insertatidinner_11',['insertAtIdInner',['../dcw_8c.html#a28b9573f49c338ba8d0ddfe4d74176fd',1,'dcw.c']]] ]; diff --git a/docs/search/all_4.js b/docs/search/all_4.js index aeddf04..c8ad83d 100644 --- a/docs/search/all_4.js +++ b/docs/search/all_4.js @@ -1,7 +1,5 @@ var searchData= [ - ['parse_5fhtml_11',['parse_html',['../dcw__internal_8h.html#a1a6aa191c5949544ed2bfc5273b5bfe1',1,'dcw_internal.h']]], - ['parse_5fhtml_5fargs_12',['parse_html_args',['../structparse__html__args.html',1,'']]], - ['parse_5fhtml_5fcore_13',['parse_html_core',['../dcw_8c.html#af24112a36c0dc7f53feb9d064019e222',1,'parse_html_core(html_t raw_html, marker_t marker): dcw.c'],['../dcw__internal_8h.html#af24112a36c0dc7f53feb9d064019e222',1,'parse_html_core(html_t raw_html, marker_t marker): dcw.c']]], - ['parse_5fhtml_5fwrapper_14',['parse_html_wrapper',['../dcw_8c.html#a00cc4fe93ce43016d88e011fd28f646d',1,'parse_html_wrapper(parse_html_args in): dcw.c'],['../dcw__internal_8h.html#a00cc4fe93ce43016d88e011fd28f646d',1,'parse_html_wrapper(parse_html_args in): dcw.c']]] + ['marker_5ft_12',['marker_t',['../structmarker__t.html',1,'']]], + ['marker_5ftype_13',['marker_type',['../dcw__internal_8h.html#a12f1ea9cb1decaed2f0c35213be6e7db',1,'dcw_internal.h']]] ]; diff --git a/docs/search/all_5.js b/docs/search/all_5.js index 4dcf67d..c2878ce 100644 --- a/docs/search/all_5.js +++ b/docs/search/all_5.js @@ -1,5 +1,7 @@ var searchData= [ - ['remove_5fhtml_15',['remove_html',['../dcw_8c.html#aad0eda700955aeee9d359cc2cbbbd7b2',1,'dcw.c']]], - ['removeinner_16',['removeInner',['../dcw_8c.html#a6a40df184b0d6261461f3f9d4ce575cb',1,'dcw.c']]] + ['parse_5fhtml_14',['parse_html',['../dcw__internal_8h.html#a1a6aa191c5949544ed2bfc5273b5bfe1',1,'dcw_internal.h']]], + ['parse_5fhtml_5fargs_15',['parse_html_args',['../structparse__html__args.html',1,'']]], + ['parse_5fhtml_5fcore_16',['parse_html_core',['../dcw_8c.html#af24112a36c0dc7f53feb9d064019e222',1,'parse_html_core(html_t raw_html, marker_t marker): dcw.c'],['../dcw__internal_8h.html#af24112a36c0dc7f53feb9d064019e222',1,'parse_html_core(html_t raw_html, marker_t marker): dcw.c']]], + ['parse_5fhtml_5fwrapper_17',['parse_html_wrapper',['../dcw_8c.html#a00cc4fe93ce43016d88e011fd28f646d',1,'parse_html_wrapper(parse_html_args in): dcw.c'],['../dcw__internal_8h.html#a00cc4fe93ce43016d88e011fd28f646d',1,'parse_html_wrapper(parse_html_args in): dcw.c']]] ]; diff --git a/docs/search/all_6.html b/docs/search/all_6.html new file mode 100644 index 0000000..43f14ea --- /dev/null +++ b/docs/search/all_6.html @@ -0,0 +1,30 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/search/all_6.js b/docs/search/all_6.js new file mode 100644 index 0000000..a971055 --- /dev/null +++ b/docs/search/all_6.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['remove_5fhtml_5fchildren_5fof_5fid_18',['remove_html_children_of_id',['../dcw_8c.html#adc18961a391fe1dd8d971ab2fbafef57',1,'dcw.c']]], + ['remove_5fhtml_5fwith_5fclass_19',['remove_html_with_class',['../dcw_8c.html#ac110f81a2bb611a21bad374bc48dc50a',1,'dcw.c']]], + ['remove_5fstatic_5fhtml_20',['remove_static_html',['../dcw_8c.html#a5cb2b0ec5add3204e1c9db0b95414085',1,'dcw.c']]], + ['removechildrenofidinner_21',['removeChildrenOfIdInner',['../dcw_8c.html#a71a18581ec29de8d483495a7055281c6',1,'dcw.c']]], + ['removestaticinner_22',['removeStaticInner',['../dcw_8c.html#aeaca657d6c6fc56126b0cc0521538b0f',1,'dcw.c']]], + ['removewithclassinner_23',['removeWithClassInner',['../dcw_8c.html#a49968519ae90ff594810c5e5dbd3312d',1,'dcw.c']]], + ['render_5fhtml_5floop_24',['render_html_loop',['../dcw_8c.html#a15ee47c82ae3d771ea7ab7f8a65dcf74',1,'dcw.c']]] +]; diff --git a/docs/search/classes_0.js b/docs/search/classes_0.js index 1a330c3..77a3b29 100644 --- a/docs/search/classes_0.js +++ b/docs/search/classes_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['marker_5ft_17',['marker_t',['../structmarker__t.html',1,'']]] + ['marker_5ft_25',['marker_t',['../structmarker__t.html',1,'']]] ]; diff --git a/docs/search/classes_1.js b/docs/search/classes_1.js index 4d5e8ba..1fe6ba3 100644 --- a/docs/search/classes_1.js +++ b/docs/search/classes_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['parse_5fhtml_5fargs_18',['parse_html_args',['../structparse__html__args.html',1,'']]] + ['parse_5fhtml_5fargs_26',['parse_html_args',['../structparse__html__args.html',1,'']]] ]; diff --git a/docs/search/defines_0.js b/docs/search/defines_0.js index 8ef4766..843af5d 100644 --- a/docs/search/defines_0.js +++ b/docs/search/defines_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['dbg_30',['dbg',['../dcw_8c.html#ad7bacf2541029a8abefd4b8fd5e47884',1,'dcw.h']]] + ['dbg_46',['dbg',['../dcw_8h.html#ad7bacf2541029a8abefd4b8fd5e47884',1,'dcw.h']]] ]; diff --git a/docs/search/defines_1.js b/docs/search/defines_1.js index 19ff5dd..7dfc4b9 100644 --- a/docs/search/defines_1.js +++ b/docs/search/defines_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['html_31',['HTML',['../dcw_8h.html#adb7919934cdf0c9f8d1a017e77cd1b47',1,'dcw.h']]], - ['html_5ft_32',['html_t',['../dcw_8h.html#af567bc1a447b57bc4f446b93f5a3e8d2',1,'dcw.h']]] + ['html_47',['HTML',['../dcw_8h.html#adb7919934cdf0c9f8d1a017e77cd1b47',1,'dcw.h']]], + ['html_5ft_48',['html_t',['../dcw_8h.html#af567bc1a447b57bc4f446b93f5a3e8d2',1,'dcw.h']]] ]; diff --git a/docs/search/defines_2.js b/docs/search/defines_2.js index 24286bb..b55cee4 100644 --- a/docs/search/defines_2.js +++ b/docs/search/defines_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['parse_5fhtml_33',['parse_html',['../dcw__internal_8h.html#a1a6aa191c5949544ed2bfc5273b5bfe1',1,'dcw_internal.h']]] + ['parse_5fhtml_49',['parse_html',['../dcw__internal_8h.html#a1a6aa191c5949544ed2bfc5273b5bfe1',1,'dcw_internal.h']]] ]; diff --git a/docs/search/enums_0.js b/docs/search/enums_0.js index f602b47..ffd416f 100644 --- a/docs/search/enums_0.js +++ b/docs/search/enums_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['marker_5ftype_29',['marker_type',['../dcw__internal_8h.html#a12f1ea9cb1decaed2f0c35213be6e7db',1,'dcw_internal.h']]] + ['marker_5ftype_45',['marker_type',['../dcw__internal_8h.html#a12f1ea9cb1decaed2f0c35213be6e7db',1,'dcw_internal.h']]] ]; diff --git a/docs/search/files_0.js b/docs/search/files_0.js index 309b32d..40208b0 100644 --- a/docs/search/files_0.js +++ b/docs/search/files_0.js @@ -1,6 +1,6 @@ var searchData= [ - ['dcw_2ec_19',['dcw.c',['../dcw_8c.html',1,'']]], - ['dcw_2eh_20',['dcw.h',['../dcw_8h.html',1,'']]], - ['dcw_5finternal_2eh_21',['dcw_internal.h',['../dcw__internal_8h.html',1,'']]] + ['dcw_2ec_27',['dcw.c',['../dcw_8c.html',1,'']]], + ['dcw_2eh_28',['dcw.h',['../dcw_8h.html',1,'']]], + ['dcw_5finternal_2eh_29',['dcw_internal.h',['../dcw__internal_8h.html',1,'']]] ]; diff --git a/docs/search/functions_0.js b/docs/search/functions_0.js index b2fb3f4..aa93bb5 100644 --- a/docs/search/functions_0.js +++ b/docs/search/functions_0.js @@ -1,5 +1,6 @@ var searchData= [ - ['display_5fhtml_22',['display_html',['../dcw_8c.html#a236b6784517212c4a78be8b8db9b145b',1,'display_html(html_t raw_html): dcw.c'],['../dcw__internal_8h.html#acf9b4ce1e6add7b81ac2a3791fe25e1c',1,'display_html(html_t raw_html): dcw.c']]], - ['displayinner_23',['displayInner',['../dcw_8c.html#a8bad87084459d4b6a23cf22a7d706d31',1,'dcw.c']]] + ['display_5fhtml_30',['display_html',['../dcw_8c.html#a236b6784517212c4a78be8b8db9b145b',1,'display_html(html_t raw_html): dcw.c'],['../dcw__internal_8h.html#acf9b4ce1e6add7b81ac2a3791fe25e1c',1,'display_html(html_t raw_html): dcw.c']]], + ['display_5fhtml_5floop_31',['display_html_loop',['../dcw_8c.html#ab627a4f2281dbf80f07e19f0f6d25270',1,'dcw.c']]], + ['displayinner_32',['displayInner',['../dcw_8c.html#a8bad87084459d4b6a23cf22a7d706d31',1,'dcw.c']]] ]; diff --git a/docs/search/functions_1.js b/docs/search/functions_1.js index ce54cc0..4938244 100644 --- a/docs/search/functions_1.js +++ b/docs/search/functions_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['parse_5fhtml_5fcore_24',['parse_html_core',['../dcw_8c.html#af24112a36c0dc7f53feb9d064019e222',1,'parse_html_core(html_t raw_html, marker_t marker): dcw.c'],['../dcw__internal_8h.html#af24112a36c0dc7f53feb9d064019e222',1,'parse_html_core(html_t raw_html, marker_t marker): dcw.c']]], - ['parse_5fhtml_5fwrapper_25',['parse_html_wrapper',['../dcw_8c.html#a00cc4fe93ce43016d88e011fd28f646d',1,'parse_html_wrapper(parse_html_args in): dcw.c'],['../dcw__internal_8h.html#a00cc4fe93ce43016d88e011fd28f646d',1,'parse_html_wrapper(parse_html_args in): dcw.c']]] + ['insert_5fhtml_5fat_5fid_33',['insert_html_at_id',['../dcw_8c.html#aa9b20ce7dfa34677289d4c3ce971c6e6',1,'dcw.c']]], + ['insertatidinner_34',['insertAtIdInner',['../dcw_8c.html#a28b9573f49c338ba8d0ddfe4d74176fd',1,'dcw.c']]] ]; diff --git a/docs/search/functions_2.js b/docs/search/functions_2.js index 9943b41..8e00278 100644 --- a/docs/search/functions_2.js +++ b/docs/search/functions_2.js @@ -1,5 +1,5 @@ var searchData= [ - ['remove_5fhtml_26',['remove_html',['../dcw_8c.html#aad0eda700955aeee9d359cc2cbbbd7b2',1,'dcw.c']]], - ['removeinner_27',['removeInner',['../dcw_8c.html#a6a40df184b0d6261461f3f9d4ce575cb',1,'dcw.c']]] + ['parse_5fhtml_5fcore_35',['parse_html_core',['../dcw_8c.html#af24112a36c0dc7f53feb9d064019e222',1,'parse_html_core(html_t raw_html, marker_t marker): dcw.c'],['../dcw__internal_8h.html#af24112a36c0dc7f53feb9d064019e222',1,'parse_html_core(html_t raw_html, marker_t marker): dcw.c']]], + ['parse_5fhtml_5fwrapper_36',['parse_html_wrapper',['../dcw_8c.html#a00cc4fe93ce43016d88e011fd28f646d',1,'parse_html_wrapper(parse_html_args in): dcw.c'],['../dcw__internal_8h.html#a00cc4fe93ce43016d88e011fd28f646d',1,'parse_html_wrapper(parse_html_args in): dcw.c']]] ]; diff --git a/docs/search/functions_3.html b/docs/search/functions_3.html new file mode 100644 index 0000000..6da86e7 --- /dev/null +++ b/docs/search/functions_3.html @@ -0,0 +1,30 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/search/functions_3.js b/docs/search/functions_3.js new file mode 100644 index 0000000..d52344f --- /dev/null +++ b/docs/search/functions_3.js @@ -0,0 +1,10 @@ +var searchData= +[ + ['remove_5fhtml_5fchildren_5fof_5fid_37',['remove_html_children_of_id',['../dcw_8c.html#adc18961a391fe1dd8d971ab2fbafef57',1,'dcw.c']]], + ['remove_5fhtml_5fwith_5fclass_38',['remove_html_with_class',['../dcw_8c.html#ac110f81a2bb611a21bad374bc48dc50a',1,'dcw.c']]], + ['remove_5fstatic_5fhtml_39',['remove_static_html',['../dcw_8c.html#a5cb2b0ec5add3204e1c9db0b95414085',1,'dcw.c']]], + ['removechildrenofidinner_40',['removeChildrenOfIdInner',['../dcw_8c.html#a71a18581ec29de8d483495a7055281c6',1,'dcw.c']]], + ['removestaticinner_41',['removeStaticInner',['../dcw_8c.html#aeaca657d6c6fc56126b0cc0521538b0f',1,'dcw.c']]], + ['removewithclassinner_42',['removeWithClassInner',['../dcw_8c.html#a49968519ae90ff594810c5e5dbd3312d',1,'dcw.c']]], + ['render_5fhtml_5floop_43',['render_html_loop',['../dcw_8c.html#a15ee47c82ae3d771ea7ab7f8a65dcf74',1,'dcw.c']]] +]; diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js index 7f819da..314b25c 100644 --- a/docs/search/searchdata.js +++ b/docs/search/searchdata.js @@ -1,9 +1,9 @@ var indexSectionsWithContent = { - 0: "dehmpr", + 0: "dehimpr", 1: "mp", 2: "d", - 3: "dpr", + 3: "dipr", 4: "e", 5: "m", 6: "dhp" diff --git a/docs/search/variables_0.js b/docs/search/variables_0.js index 03216ec..f88b2fb 100644 --- a/docs/search/variables_0.js +++ b/docs/search/variables_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['error_5fhtml_28',['ERROR_HTML',['../dcw_8c.html#a426faf00e00772908cbebc65fe487bd8',1,'dcw.c']]] + ['error_5fhtml_44',['ERROR_HTML',['../dcw_8c.html#a426faf00e00772908cbebc65fe487bd8',1,'dcw.c']]] ]; diff --git a/example/dependencies/dcw/dcw.js b/example/dependencies/dcw/dcw.js deleted file mode 100644 index 8149f8c..0000000 --- a/example/dependencies/dcw/dcw.js +++ /dev/null @@ -1,23 +0,0 @@ -mergeInto(LibraryManager.library, { - displayInner: function (html) { - var element = document.getElementById("output_dcw"); - if (!element) { - var element = document.createElement("div"); - element.id = "output_dcw"; - document.body.appendChild(element); - } - element.innerHTML += UTF8ToString(html); - }, - removeInner: function (html) { - var element = document.getElementById("output_dcw"); - if (!element) { - var element = document.createElement("div"); - element.id = "output_dcw"; - document.body.appendChild(element); - } - element.innerHTML = element.innerHTML.replace( - UTF8ToString(html), - "" - ); - }, -}); diff --git a/example/dependencies/dcw/dcw.o b/example/dependencies/dcw/dcw.o deleted file mode 100644 index 56a638e..0000000 Binary files a/example/dependencies/dcw/dcw.o and /dev/null differ diff --git a/example/index.html b/example/index.html deleted file mode 100644 index 6abfeaf..0000000 --- a/example/index.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - DanCing Web Example - - - - - diff --git a/examples/counter/.gitignore b/examples/counter/.gitignore new file mode 100644 index 0000000..bcda7b7 --- /dev/null +++ b/examples/counter/.gitignore @@ -0,0 +1,3 @@ +build/ +releases/ +# dependencies/ folder is not ignored because tapm doesn't have a npm init equivalent command yet diff --git a/example/Makefile b/examples/counter/Makefile similarity index 53% rename from example/Makefile rename to examples/counter/Makefile index 654a1e8..e12aa77 100644 --- a/example/Makefile +++ b/examples/counter/Makefile @@ -1,9 +1,9 @@ -P=hello_world -OBJECTS=src/hello_world.c -EMCC=emcc -EMCC_CFLAGS=-s MAIN_MODULE=1 --js-library dependencies/dcw/dcw.js -BUILDDIR=build -DEPENDENCIES=dependencies/dcw/dcw.o - -$(P): $(OBJECTS) - $(EMCC) $(EMCC_CFLAGS) $(DEPENDENCIES) src/hello_world.c -o $(BUILDDIR)/$(P).js \ No newline at end of file +P=counter +OBJECTS=src/main.c +EMCC=emcc +EMCC_CFLAGS=-s MAIN_MODULE=1 --js-library dependencies/dcw/dcw.js +BUILDDIR=build +DEPENDENCIES=dependencies/dcw/dcw.o + +$(P): $(OBJECTS) + $(EMCC) $(EMCC_CFLAGS) $(DEPENDENCIES) src/main.c -o $(BUILDDIR)/$(P).js \ No newline at end of file diff --git a/example/Tarantella.toml b/examples/counter/Tarantella.toml similarity index 85% rename from example/Tarantella.toml rename to examples/counter/Tarantella.toml index 7457a8c..1ccd82c 100644 --- a/example/Tarantella.toml +++ b/examples/counter/Tarantella.toml @@ -1,9 +1,10 @@ -[package] -name = "hello_world" -version = "0.1.0" # format: major.minor.patch -module_type = "main_module" # main_module || side_module -build_dir = "build" # when modifying this field, change BUILD_DIR in the Makefile too -releases_repo = "" # format: https://github.com// - -[dependencies] # dependencies should not be added manually, use the tapm add command instead -dcw = "danbugs/dancing_web 0.3.0" \ No newline at end of file +[package] +name = "counter" +version = "0.1.0" # format: major.minor.patch +module_type = "main_module" # main_module || side_module +build_dir = "build" # when modifying this field, change BUILD_DIR in the Makefile too +releases_repo = "" # format: https://github.com// + +[dependencies] # dependencies should not be added manually, use the tapm add command instead + +dcw = "danbugs/dancing_web 0.4.0" \ No newline at end of file diff --git a/example/dependencies/dcw/Tarantella.toml b/examples/counter/dependencies/dcw/Tarantella.toml similarity index 56% rename from example/dependencies/dcw/Tarantella.toml rename to examples/counter/dependencies/dcw/Tarantella.toml index 134507e..912c770 100644 --- a/example/dependencies/dcw/Tarantella.toml +++ b/examples/counter/dependencies/dcw/Tarantella.toml @@ -1,8 +1,8 @@ -[package] -name = "dcw" -version = "0.3.0" # format: major.minor.patch -module_type = "side_module" # main_module || side_module -build_dir = "build" # when modifying this field, change BUILD_DIR in the Makefile too -releases_repo = "https://github.com/danbugs/dancing_webhttps://github.com/danbugs/dancing_web" # format: https://github.com// - -[dependencies] # dependencies should not be added manually, use the tapm add command instead +[package] +name = "dcw" +version = "0.4.0" # format: major.minor.patch +module_type = "side_module" # main_module || side_module +build_dir = "build" # when modifying this field, change BUILD_DIR in the Makefile too +releases_repo = "https://github.com/danbugs/dancing_web" # format: https://github.com// + +[dependencies] # dependencies should not be added manually, use the tapm add command instead diff --git a/example/dependencies/dcw/dcw.h b/examples/counter/dependencies/dcw/dcw.h similarity index 87% rename from example/dependencies/dcw/dcw.h rename to examples/counter/dependencies/dcw/dcw.h index 4139fab..2ad9068 100644 --- a/example/dependencies/dcw/dcw.h +++ b/examples/counter/dependencies/dcw/dcw.h @@ -1,30 +1,36 @@ -#pragma once -/** \file - Useful macros intended to be used by the end-user. -*/ - -/* - * Copyright 2021 Danilo Chiarlone - * LICENSE: GNU AFFERO GENERAL PUBLIC LICENSE -*/ - -/** A macro that expands to the \c char* type — created to distinguish between normal strings and those that are meant to be rendered to the DOM. -*/ -#define html_t char * - -/** A function macro to allow embedding HTML within C files. -*/ -#define HTML(...) #__VA_ARGS__; - -/** A utility function for easy debug. It prints the variable name and its' value. - Usage: - char *hello_world = "Hello, World!"; - dbg(hello_world, %d); - - Output: - "hello_world: Hello, World!" -*/ -#define dbg(to_print, formatter) \ - { \ - printf(#to_print ": " #formatter "\n", to_print); \ - } \ No newline at end of file +/** \file + Useful macros intended to be used by the end-user. +*/ + +/* + * Copyright 2021 Danilo Chiarlone + * LICENSE: GNU AFFERO GENERAL PUBLIC LICENSE +*/ + +#ifndef DCW_H +#define DCW_H + +/** A macro that expands to the \c char* type — created to distinguish between normal strings and those that are meant to be rendered to the DOM. +*/ +#define html_t char * + +/** A function macro to allow embedding HTML within C files. +*/ +#define HTML(...) #__VA_ARGS__ + +#define HTMLIFY(str) (html_t) str + +/** A utility function for easy debug. It prints the variable name and its' value. + Usage: + char *hello_world = "Hello, World!"; + dbg(hello_world, %d); + + Output: + "hello_world: Hello, World!" +*/ +#define dbg(to_print, formatter) \ + { \ + printf(#to_print ": " #formatter "\n", to_print); \ + } + +#endif \ No newline at end of file diff --git a/examples/counter/dependencies/dcw/dcw.js b/examples/counter/dependencies/dcw/dcw.js new file mode 100644 index 0000000..2b02b78 --- /dev/null +++ b/examples/counter/dependencies/dcw/dcw.js @@ -0,0 +1,43 @@ +mergeInto(LibraryManager.library, { + displayInner: function (html) { + var element = document.getElementById("output_dcw"); + if (!element) { + var element = document.createElement("div"); + element.id = "output_dcw"; + document.body.appendChild(element); + } + element.innerHTML += UTF8ToString(html); + }, + removeStaticInner: function (html) { + var element = document.getElementById("output_dcw"); + if (!element) { + var element = document.createElement("div"); + element.id = "output_dcw"; + document.body.appendChild(element); + } + element.innerHTML = element.innerHTML.replace(UTF8ToString(html), ""); + }, + removeWithClassInner: function (className) { + let element = document.querySelectorAll(`.${UTF8ToString(className)}`); + if (element) { + element.forEach(function (e) { + e.remove(); + }); + } + }, + removeChildrenOfIdInner: function (id) { + let element = document.querySelector(`#${UTF8ToString(id)}`); + while (element.lastChild) { + element.removeChild(element.lastChild); + } + }, + insertInner: function (html, id) { + let element = document.querySelector(`#${UTF8ToString(id)}`); + if (!element) { + element = document.createElement("div"); + element.id = UTF8ToString(id); + document.body.appendChild(element); + } + element.innerHTML += UTF8ToString(html); + } +}); diff --git a/examples/counter/dependencies/dcw/dcw.o b/examples/counter/dependencies/dcw/dcw.o new file mode 100644 index 0000000..b9bc4e8 Binary files /dev/null and b/examples/counter/dependencies/dcw/dcw.o differ diff --git a/example/frontend/favicon.ico b/examples/counter/frontend/favicon.ico similarity index 100% rename from example/frontend/favicon.ico rename to examples/counter/frontend/favicon.ico diff --git a/example/frontend/hello_world.cml b/examples/counter/frontend/hello_world.cml similarity index 83% rename from example/frontend/hello_world.cml rename to examples/counter/frontend/hello_world.cml index f78447d..162939b 100644 --- a/example/frontend/hello_world.cml +++ b/examples/counter/frontend/hello_world.cml @@ -1,6 +1,6 @@ -HTML( -
-

${get_counter()}$

- -
+HTML( +
+

${get_counter()}$

+ +
); \ No newline at end of file diff --git a/examples/counter/index.html b/examples/counter/index.html new file mode 100644 index 0000000..b947803 --- /dev/null +++ b/examples/counter/index.html @@ -0,0 +1,11 @@ + + + + + Tarantella App + + +

Hello, Tarantella 💃🕷

+ + + \ No newline at end of file diff --git a/example/src/hello_world.c b/examples/counter/src/main.c similarity index 74% rename from example/src/hello_world.c rename to examples/counter/src/main.c index e5969c4..eb5a372 100644 --- a/example/src/hello_world.c +++ b/examples/counter/src/main.c @@ -1,35 +1,34 @@ -#include -#include -#include -#include "../dependencies/dcw/dcw.h" -// #include "../../src/dcw.h" -> for when I'm checking for mem leaks - -extern void remove_html(html_t raw_html); -extern void display_html(html_t raw_html); - -html_t main_h = -#include "../frontend/hello_world.cml" - ; - -int counter = 0; - -EMSCRIPTEN_KEEPALIVE -void increase_counter() -{ - remove_html(main_h); - counter++; - display_html(main_h); -} - -EMSCRIPTEN_KEEPALIVE -html_t get_counter() -{ - html_t tmp = malloc(128 * sizeof(char)); - sprintf(tmp, "%d\n", counter); - return tmp; -} - -int main() -{ - display_html(main_h); +#include +#include +#include +#include "../dependencies/dcw/dcw.h" + +extern void remove_html_with_class(char* class_name); +extern void display_html(html_t raw_html); + +html_t main_h = +#include "../frontend/hello_world.cml" + ; + +int counter = 0; + +EMSCRIPTEN_KEEPALIVE +void increase_counter() +{ + remove_html_with_class("counter"); + counter++; + display_html(main_h); +} + +EMSCRIPTEN_KEEPALIVE +html_t get_counter() +{ + html_t tmp = malloc(128 * sizeof(char)); + sprintf(tmp, "%d\n", counter); + return tmp; +} + +int main() +{ + display_html(main_h); } \ No newline at end of file diff --git a/examples/form/.gitignore b/examples/form/.gitignore new file mode 100644 index 0000000..bcda7b7 --- /dev/null +++ b/examples/form/.gitignore @@ -0,0 +1,3 @@ +build/ +releases/ +# dependencies/ folder is not ignored because tapm doesn't have a npm init equivalent command yet diff --git a/examples/form/Makefile b/examples/form/Makefile new file mode 100644 index 0000000..e09cd01 --- /dev/null +++ b/examples/form/Makefile @@ -0,0 +1,9 @@ +P=form +OBJECTS=src/main.c +EMCC=emcc +EMCC_CFLAGS=-s MAIN_MODULE=1 --js-library dependencies/dcw/dcw.js -s "EXPORTED_RUNTIME_METHODS=['allocateUTF8']" +BUILDDIR=build +DEPENDENCIES=dependencies/dcw/dcw.o + +$(P): $(OBJECTS) + $(EMCC) $(EMCC_CFLAGS) $(DEPENDENCIES) src/main.c -o $(BUILDDIR)/$(P).js \ No newline at end of file diff --git a/examples/form/Tarantella.toml b/examples/form/Tarantella.toml new file mode 100644 index 0000000..7088e8f --- /dev/null +++ b/examples/form/Tarantella.toml @@ -0,0 +1,10 @@ +[package] +name = "form" +version = "0.1.0" # format: major.minor.patch +module_type = "main_module" # main_module || side_module +build_dir = "build" # when modifying this field, change BUILD_DIR in the Makefile too +releases_repo = "" # format: https://github.com// + +[dependencies] # dependencies should not be added manually, use the tapm add command instead + +dcw = "danbugs/dancing_web 0.4.0" \ No newline at end of file diff --git a/examples/form/dependencies/dcw/Tarantella.toml b/examples/form/dependencies/dcw/Tarantella.toml new file mode 100644 index 0000000..912c770 --- /dev/null +++ b/examples/form/dependencies/dcw/Tarantella.toml @@ -0,0 +1,8 @@ +[package] +name = "dcw" +version = "0.4.0" # format: major.minor.patch +module_type = "side_module" # main_module || side_module +build_dir = "build" # when modifying this field, change BUILD_DIR in the Makefile too +releases_repo = "https://github.com/danbugs/dancing_web" # format: https://github.com// + +[dependencies] # dependencies should not be added manually, use the tapm add command instead diff --git a/examples/form/dependencies/dcw/dcw.h b/examples/form/dependencies/dcw/dcw.h new file mode 100644 index 0000000..2ad9068 --- /dev/null +++ b/examples/form/dependencies/dcw/dcw.h @@ -0,0 +1,36 @@ +/** \file + Useful macros intended to be used by the end-user. +*/ + +/* + * Copyright 2021 Danilo Chiarlone + * LICENSE: GNU AFFERO GENERAL PUBLIC LICENSE +*/ + +#ifndef DCW_H +#define DCW_H + +/** A macro that expands to the \c char* type — created to distinguish between normal strings and those that are meant to be rendered to the DOM. +*/ +#define html_t char * + +/** A function macro to allow embedding HTML within C files. +*/ +#define HTML(...) #__VA_ARGS__ + +#define HTMLIFY(str) (html_t) str + +/** A utility function for easy debug. It prints the variable name and its' value. + Usage: + char *hello_world = "Hello, World!"; + dbg(hello_world, %d); + + Output: + "hello_world: Hello, World!" +*/ +#define dbg(to_print, formatter) \ + { \ + printf(#to_print ": " #formatter "\n", to_print); \ + } + +#endif \ No newline at end of file diff --git a/examples/form/dependencies/dcw/dcw.js b/examples/form/dependencies/dcw/dcw.js new file mode 100644 index 0000000..2b02b78 --- /dev/null +++ b/examples/form/dependencies/dcw/dcw.js @@ -0,0 +1,43 @@ +mergeInto(LibraryManager.library, { + displayInner: function (html) { + var element = document.getElementById("output_dcw"); + if (!element) { + var element = document.createElement("div"); + element.id = "output_dcw"; + document.body.appendChild(element); + } + element.innerHTML += UTF8ToString(html); + }, + removeStaticInner: function (html) { + var element = document.getElementById("output_dcw"); + if (!element) { + var element = document.createElement("div"); + element.id = "output_dcw"; + document.body.appendChild(element); + } + element.innerHTML = element.innerHTML.replace(UTF8ToString(html), ""); + }, + removeWithClassInner: function (className) { + let element = document.querySelectorAll(`.${UTF8ToString(className)}`); + if (element) { + element.forEach(function (e) { + e.remove(); + }); + } + }, + removeChildrenOfIdInner: function (id) { + let element = document.querySelector(`#${UTF8ToString(id)}`); + while (element.lastChild) { + element.removeChild(element.lastChild); + } + }, + insertInner: function (html, id) { + let element = document.querySelector(`#${UTF8ToString(id)}`); + if (!element) { + element = document.createElement("div"); + element.id = UTF8ToString(id); + document.body.appendChild(element); + } + element.innerHTML += UTF8ToString(html); + } +}); diff --git a/examples/form/dependencies/dcw/dcw.o b/examples/form/dependencies/dcw/dcw.o new file mode 100644 index 0000000..b9bc4e8 Binary files /dev/null and b/examples/form/dependencies/dcw/dcw.o differ diff --git a/examples/form/index.html b/examples/form/index.html new file mode 100644 index 0000000..00d8c9e --- /dev/null +++ b/examples/form/index.html @@ -0,0 +1,11 @@ + + + + + Tarantella App + + +

Hello, Tarantella 💃🕷

+ + + \ No newline at end of file diff --git a/examples/form/src/main.c b/examples/form/src/main.c new file mode 100644 index 0000000..c5e8954 --- /dev/null +++ b/examples/form/src/main.c @@ -0,0 +1,65 @@ +#include +#include +#include +#include "../dependencies/dcw/dcw.h" + +extern void remove_html_with_class(char *class_name); +extern void display_html(html_t raw_html); + +typedef struct +{ + char *first_name; + char *last_name; +} FormInput; + +FormInput finput; + +html_t form_h = HTMLIFY(" \ +
\ +
\ +
\ +
\ +

\ +
\ + \ +"); + +html_t display_h = HTMLIFY(" \ +
\ +

First Name: ${get_first_name()}$

\ +

Last Name: ${get_last_name()}$

\ +
\ +"); + +EMSCRIPTEN_KEEPALIVE +void set_first_name(char* value) { + asprintf(&(finput.first_name), "%s", value); + free(value); +} + +EMSCRIPTEN_KEEPALIVE +html_t get_first_name() { + return finput.first_name; +} + +EMSCRIPTEN_KEEPALIVE +void set_last_name(char* value) { + asprintf(&(finput.last_name), "%s", value); + free(value); +} + +EMSCRIPTEN_KEEPALIVE +html_t get_last_name() { + return finput.last_name; +} + +EMSCRIPTEN_KEEPALIVE +void form_submit(char* value) { + remove_html_with_class("display"); + display_html(display_h); +} + + +int main() { + display_html(form_h); +} \ No newline at end of file diff --git a/examples/html_loop/.gitignore b/examples/html_loop/.gitignore new file mode 100644 index 0000000..bcda7b7 --- /dev/null +++ b/examples/html_loop/.gitignore @@ -0,0 +1,3 @@ +build/ +releases/ +# dependencies/ folder is not ignored because tapm doesn't have a npm init equivalent command yet diff --git a/examples/html_loop/Makefile b/examples/html_loop/Makefile new file mode 100644 index 0000000..e27e137 --- /dev/null +++ b/examples/html_loop/Makefile @@ -0,0 +1,9 @@ +P=html_loop +OBJECTS=src/main.c +EMCC=emcc +EMCC_CFLAGS=-s MAIN_MODULE=1 --js-library dependencies/dcw/dcw.js +BUILDDIR=build +DEPENDENCIES=dependencies/dcw/dcw.o + +$(P): $(OBJECTS) + $(EMCC) $(EMCC_CFLAGS) $(DEPENDENCIES) src/main.c -o $(BUILDDIR)/$(P).js \ No newline at end of file diff --git a/examples/html_loop/Tarantella.toml b/examples/html_loop/Tarantella.toml new file mode 100644 index 0000000..e3471ab --- /dev/null +++ b/examples/html_loop/Tarantella.toml @@ -0,0 +1,10 @@ +[package] +name = "html_loop" +version = "0.1.0" # format: major.minor.patch +module_type = "main_module" # main_module || side_module +build_dir = "build" # when modifying this field, change BUILD_DIR in the Makefile too +releases_repo = "" # format: https://github.com// + +[dependencies] # dependencies should not be added manually, use the tapm add command instead + +dcw = "danbugs/dancing_web 0.4.0" \ No newline at end of file diff --git a/examples/html_loop/dependencies/dcw/Tarantella.toml b/examples/html_loop/dependencies/dcw/Tarantella.toml new file mode 100644 index 0000000..912c770 --- /dev/null +++ b/examples/html_loop/dependencies/dcw/Tarantella.toml @@ -0,0 +1,8 @@ +[package] +name = "dcw" +version = "0.4.0" # format: major.minor.patch +module_type = "side_module" # main_module || side_module +build_dir = "build" # when modifying this field, change BUILD_DIR in the Makefile too +releases_repo = "https://github.com/danbugs/dancing_web" # format: https://github.com// + +[dependencies] # dependencies should not be added manually, use the tapm add command instead diff --git a/examples/html_loop/dependencies/dcw/dcw.h b/examples/html_loop/dependencies/dcw/dcw.h new file mode 100644 index 0000000..2ad9068 --- /dev/null +++ b/examples/html_loop/dependencies/dcw/dcw.h @@ -0,0 +1,36 @@ +/** \file + Useful macros intended to be used by the end-user. +*/ + +/* + * Copyright 2021 Danilo Chiarlone + * LICENSE: GNU AFFERO GENERAL PUBLIC LICENSE +*/ + +#ifndef DCW_H +#define DCW_H + +/** A macro that expands to the \c char* type — created to distinguish between normal strings and those that are meant to be rendered to the DOM. +*/ +#define html_t char * + +/** A function macro to allow embedding HTML within C files. +*/ +#define HTML(...) #__VA_ARGS__ + +#define HTMLIFY(str) (html_t) str + +/** A utility function for easy debug. It prints the variable name and its' value. + Usage: + char *hello_world = "Hello, World!"; + dbg(hello_world, %d); + + Output: + "hello_world: Hello, World!" +*/ +#define dbg(to_print, formatter) \ + { \ + printf(#to_print ": " #formatter "\n", to_print); \ + } + +#endif \ No newline at end of file diff --git a/examples/html_loop/dependencies/dcw/dcw.js b/examples/html_loop/dependencies/dcw/dcw.js new file mode 100644 index 0000000..3d4c6cf --- /dev/null +++ b/examples/html_loop/dependencies/dcw/dcw.js @@ -0,0 +1,43 @@ +mergeInto(LibraryManager.library, { + displayInner: function (html) { + var element = document.getElementById("output_dcw"); + if (!element) { + var element = document.createElement("div"); + element.id = "output_dcw"; + document.body.appendChild(element); + } + element.innerHTML += UTF8ToString(html); + }, + removeStaticInner: function (html) { + var element = document.getElementById("output_dcw"); + if (!element) { + var element = document.createElement("div"); + element.id = "output_dcw"; + document.body.appendChild(element); + } + element.innerHTML = element.innerHTML.replace(UTF8ToString(html), ""); + }, + removeWithClassInner: function (className) { + let element = document.querySelectorAll(`.${UTF8ToString(className)}`); + if (element) { + element.forEach(function (e) { + e.remove(); + }); + } + }, + removeWithIdInner: function (id) { + let element = document.querySelector(`#${UTF8ToString(id)}`); + while (element.lastChild) { + element.removeChild(element.lastChild); + } + }, + insertInner: function (html, id) { + let element = document.querySelector(`#${UTF8ToString(id)}`); + if (!element) { + element = document.createElement("div"); + element.id = UTF8ToString(id); + document.body.appendChild(element); + } + element.innerHTML += UTF8ToString(html); + } +}); diff --git a/examples/html_loop/dependencies/dcw/dcw.o b/examples/html_loop/dependencies/dcw/dcw.o new file mode 100644 index 0000000..4b81978 Binary files /dev/null and b/examples/html_loop/dependencies/dcw/dcw.o differ diff --git a/examples/html_loop/frontend/list.cml b/examples/html_loop/frontend/list.cml new file mode 100644 index 0000000..3198561 --- /dev/null +++ b/examples/html_loop/frontend/list.cml @@ -0,0 +1,3 @@ +HTML( +

%s

+); diff --git a/examples/html_loop/frontend/main.cml b/examples/html_loop/frontend/main.cml new file mode 100644 index 0000000..08d823a --- /dev/null +++ b/examples/html_loop/frontend/main.cml @@ -0,0 +1,3 @@ +HTML( +${list_elements()}$ +); diff --git a/examples/html_loop/index.html b/examples/html_loop/index.html new file mode 100644 index 0000000..d9d7de4 --- /dev/null +++ b/examples/html_loop/index.html @@ -0,0 +1,11 @@ + + + + + Tarantella App + + +

Hello, Tarantella 💃🕷

+ + + \ No newline at end of file diff --git a/examples/html_loop/src/main.c b/examples/html_loop/src/main.c new file mode 100644 index 0000000..6c177e4 --- /dev/null +++ b/examples/html_loop/src/main.c @@ -0,0 +1,40 @@ +#include +#include +#include +#include +#include "../dependencies/dcw/dcw.h" + +html_t main_h = HTMLIFY("
"); +html_t list_h = HTMLIFY("

%s

"); + +extern html_t render_html_loop(html_t html_formatter, char **elements, int num_elements, bool reverse); +extern void insert_html_at_id(html_t raw_html, char *id); +extern void display_html(html_t raw_html); + +html_t list_elements() +{ + const int num_months = 12; + + char *months[num_months] = { + "January", + "February", + "March", + "April", + "May", + "June", + "July", + "August", + "September", + "October", + "November", + "December"}; + + html_t some_html = render_html_loop(list_h, months, num_months, false); + insert_html_at_id(some_html, "main_body"); + free(some_html); +} + +int main() +{ + list_elements(); +} \ No newline at end of file diff --git a/src/dcw.c b/src/dcw.c index af8c625..b3a4e00 100644 --- a/src/dcw.c +++ b/src/dcw.c @@ -17,6 +17,7 @@ #include // needed for sprintf #include // needed for free #include // needed for strcat, and strlen +#include // needed for bool, true, and false /** \mainpage \n @@ -36,14 +37,31 @@ html_t ERROR_HTML = */ extern void displayInner(html_t html); -/** A JS funtion that removes HTML from the DOM. +/** A JS funtion that removes static HTML from the DOM. \param html The HTML you want to remove. This should be of type html_t or char*. */ -extern void removeInner(html_t html); +extern void removeStaticInner(html_t html); + +/** A JS funtion that removes HTML from the DOM with a specific class. + \param html The class of the HTML you want to remove. +*/ +extern void removeWithClassInner(char *class_name); + +/** A JS funtion that removes the children of an HTML node with a specific ID. + \param html The ID of the parent HTML. +*/ +extern void removeChildrenOfIdInner(char *id); + +/** A JS funtion that renders the HTML to the DOM at a specific ID. + \param html The HTML you want to render. This should be of type html_t or char*. + \param id The id of the HTML you want to render. +*/ +extern void insertAtIdInner(html_t html, char* id); /** A wrapper around \c parse_html_core to allow setting default argument values. \param in This should contain the some raw html and, maybe, the type - of marker to look for. \return The HTML that is ready to be rendered. + of marker to look for. + \return The HTML that is ready to be rendered. */ html_t parse_html_wrapper(parse_html_args in) { @@ -74,7 +92,8 @@ html_t parse_html_wrapper(parse_html_args in) /** Find and execute any C function calls within the raw html. \param raw_html The HTML you want to parse. This should be of type html_t or - char*. \return The HTML that is ready to be rendered. + char*. + \return The HTML that is ready to be rendered. */ html_t parse_html_core(html_t raw_html, marker_t marker) { @@ -151,14 +170,102 @@ void display_html(html_t raw_html) displayInner(rendered_html); } -/** A wrapper for \c parse_html, and the JS funtion \c removeInner . +/** A wrapper for \c parse_html, and the JS funtion \c removeStaticInner . \param raw_html The HTML you want to remove. This should be of type html_t or char*. */ EMSCRIPTEN_KEEPALIVE -void remove_html(html_t raw_html) +void remove_static_html(html_t raw_html) +{ + html_t rendered_html = parse_html(raw_html); + removeStaticInner(rendered_html); +} + +/** A wrapper for the JS funtion \c removeWithClassInner . + + \param class_name The class of the HTML you want to remove. This should be of type html_t + or char*. +*/ +EMSCRIPTEN_KEEPALIVE +void remove_html_with_class(char *class_name) +{ + removeWithClassInner(class_name); +} + +/** Displays a \c char** as HTML inside a specific HTML formatter. + + \param html_formatter Where each element of your \c char** will be rendered (e.g., "

%s

") - use normal C formatters. + \param elements The array you want to render. + \param num_elements The number of elements of the \c elements array. + \param reverse If \c true , the array will be rendered in reverse. + or char*. +*/ +EMSCRIPTEN_KEEPALIVE +void display_html_loop(html_t html_formatter, char **elements, int num_elements, bool reverse) +{ + int i; + + for ((reverse) ? (i = num_elements - 1) : (i = 0); (reverse) ? (i >= 0) : (i < num_elements); (reverse) ? (i--) : (i++)) + { + char *tmp; + asprintf(&tmp, html_formatter, + *(elements + i)); + display_html(tmp); + free(tmp); + } +} + +/** Renders a \c char** as HTML inside a specific HTML formatter. + + \param html_formatter Where each element of your \c char** will be rendered (e.g., "

%s

") - use normal C formatters. + \param elements The array you want to render. + \param num_elements The number of elements of the \c elements array. + \param reverse If \c true , the array will be rendered in reverse. + + \return The rendered HTML that can be inserted into any part of the DOM. + or char*. +*/ +EMSCRIPTEN_KEEPALIVE +html_t render_html_loop(html_t html_formatter, char **elements, int num_elements, bool reverse) +{ + int i; + + char *result = (char*) NULL; + char *full_formatter = malloc(sizeof(html_formatter) + 4); + strcat(full_formatter, "%s"); + strcat(full_formatter, html_formatter); + + for ((reverse) ? (i = num_elements - 1) : (i = 0); (reverse) ? (i >= 0) : (i < num_elements); (reverse) ? (i--) : (i++)) + { + asprintf(&result, full_formatter, (result) ? (result) : (""), + *(elements + i)); + } + + free(full_formatter); + return result; +} + +/** A wrapper for the JS funtion \c removeChildrenOfIdInner . + + \param class_name The id of the HTML you want to remove the children of. This should be of type html_t + or char*. +*/ +EMSCRIPTEN_KEEPALIVE +void remove_html_children_of_id(char *id) +{ + removeChildrenOfIdInner(id); +} + +/** A wrapper for \c parse_html, and the JS funtion \c insertAtIdInner . + + \param raw_html The HTML you want to display. This should be of type html_t + or char*. + \param id The ID where you want to insert the parsed HTML at. +*/ +EMSCRIPTEN_KEEPALIVE +void insert_html_at_id(html_t raw_html, char *id) { html_t rendered_html = parse_html(raw_html); - removeInner(rendered_html); -} \ No newline at end of file + insertAtIdInner(rendered_html, id); +}; \ No newline at end of file diff --git a/src/dcw.h b/src/dcw.h index 2ff2920..76c72e9 100644 --- a/src/dcw.h +++ b/src/dcw.h @@ -16,7 +16,9 @@ /** A function macro to allow embedding HTML within C files. */ -#define HTML(...) #__VA_ARGS__; +#define HTML(...) #__VA_ARGS__ + +#define HTMLIFY(str) (html_t) str /** A utility function for easy debug. It prints the variable name and its' value. Usage: diff --git a/src/dcw.js b/src/dcw.js index 8149f8c..9ef8a81 100644 --- a/src/dcw.js +++ b/src/dcw.js @@ -8,16 +8,36 @@ mergeInto(LibraryManager.library, { } element.innerHTML += UTF8ToString(html); }, - removeInner: function (html) { + removeStaticInner: function (html) { var element = document.getElementById("output_dcw"); if (!element) { var element = document.createElement("div"); element.id = "output_dcw"; document.body.appendChild(element); } - element.innerHTML = element.innerHTML.replace( - UTF8ToString(html), - "" - ); + element.innerHTML = element.innerHTML.replace(UTF8ToString(html), ""); }, + removeWithClassInner: function (className) { + let element = document.querySelectorAll(`.${UTF8ToString(className)}`); + if (element) { + element.forEach(function (e) { + e.remove(); + }); + } + }, + removeChildrenOfIdInner: function (id) { + let element = document.querySelector(`#${UTF8ToString(id)}`); + while (element.lastChild) { + element.removeChild(element.lastChild); + } + }, + insertAtIdInner: function (html, id) { + let element = document.querySelector(`#${UTF8ToString(id)}`); + if (!element) { + element = document.createElement("div"); + element.id = UTF8ToString(id); + document.body.appendChild(element); + } + element.innerHTML += UTF8ToString(html); + } });