Allow customising base URLs

Author: Crissium

README.md

@@ -31,8 +31,12 @@ Needless to say, you should have the development package of Python installed. No
 >>> import dsl
 >>> dsl.to_html(''' [m0][b]com·mu·ta·tor[/b] [p]7[/p] {{id=000008943}} [c rosybrown]\[[/c][c darkslategray][b]commutator[/b][/c] [c darkslategray][b]commutators[/b][/c][c rosybrown]\][/c] [p]BrE[/p] [c darkgray] [/c][c darkcyan]\[ˈkɒmjuteɪtə(r)\][/c] [s]z_commutator__gb_1.wav[/s] [p]NAmE[/p] [c darkgray] [/c][c darkcyan]\[ˈkɑːmjuteɪtər\][/c] [s]z_commutator__us_1.wav[/s] [c orange] noun[/c] [c darkgray] ([/c][c green]physics[/c][c darkgray])[/c]
 ...  [m1][c darkmagenta][b]1.[/b][/c] {{d}}a device that connects a motor to the electricity supply{{/d}}
-...  [m1][c darkmagenta][b]2.[/b][/c] {{d}}a device for changing the direction in which electricity flows{{/d}}''', 'test')
-(' <div style="margin-left: 0px;"><b>com·mu·ta·tor</b> <i><font color="green">7</font></i>  <span style="color: rosybrown;">[</span><span style="color: darkslategray;"><b>commutator</b></span> <span style="color: darkslategray;"><b>commutators</b></span><span style="color: rosybrown;">]</span> <i><font color="green">BrE</font></i> <span style="color: darkgray;"> </span><span style="color: darkcyan;">[ˈkɒmjuteɪtə(r)]</span> <audio controls autoplay src="/api/cache/test/z_commutator__gb_1.wav">z_commutator__gb_1.wav</audio> <i><font color="green">NAmE</font></i> <span style="color: darkgray;"> </span><span style="color: darkcyan;">[ˈkɑːmjuteɪtər]</span> <audio controls src="/api/cache/test/z_commutator__us_1.wav">z_commutator__us_1.wav</audio> <span style="color: orange;"> noun</span> <span style="color: darkgray;"> (</span><span style="color: green;">physics</span><span style="color: darkgray;">)</span> </div><div style="margin-left: 9px;"><span style="color: darkmagenta;"><b>1.</b></span> a device that connects a motor to the electricity supply </div><div style="margin-left: 9px;"><span style="color: darkmagenta;"><b>2.</b></span> a device for changing the direction in which electricity flows</div>', ['z_commutator__gb_1.wav', 'z_commutator__us_1.wav'])
+...  [m1][c darkmagenta][b]2.[/b][/c] {{d}}a device for changing the direction in which electricity flows{{/d}}''', '/static', '/lookup')
+(' <div style="margin-left: 0px;"><b>com·mu·ta·tor</b> <i><font color="green">7</font></i>  <span style="color: rosybrown;">[</span><span style="color: darkslategray;"><b>commutator</b></span> <span style="color: darkslategray;"><b>commutators</b></span><span style="color: rosybrown;">]</span> <i><font color="green">BrE</font></i> <span style="color: darkgray;"> </span><span style="color: darkcyan;">[ˈkɒmjuteɪtə(r)]</span> <audio controls autoplay src="/api/cache/test/z_commutator__gb_1.wav">z_commutator__gb_1.wav</audio> <i><font color="green">NAmE</font></i> <span style="color: darkgray;"> </span><span style="color: darkcyan;">[ˈkɑːmjuteɪtər]</span> <audio controls src="/api/cache/test/z_commutator__us_1.wavargs">z_commutator__us_1.wav</audio> <span style="color: orange;"> noun</span> <span style="color: darkgray;"> (</span><span style="color: green;">physics</span><span style="color: darkgray;">)</span> </div><div style="margin-left: 9px;"><span style="color: darkmagenta;"><b>1.</b></span> a device that connects a motor to the electricity supply </div><div style="margin-left: 9px;"><span style="color: darkmagenta;"><b>2.</b></span> a device for changing the direction in which electricity flows</div>', ['z_commutator__gb_1.wav', 'z_commutator__us_1.wav'])
 ```
 
-The module has only one function: `to_html`, which takes two arguments: the DSL string and the dictionary name, and returns a tuple of two elements: the HTML string and a list of media file names.
+The module has only one function: `to_html`, which takes three arguments: the DSL string and the base URLs for static files and lookup, and returns a tuple of two elements: the HTML string and a list of media file names.
+
+# To do
+
+- Allow custom styling by putting the DSL tags into classes

pyproject.toml

@@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dsl2html"
-version = "0.1.5"
+version = "0.2.0"
 authors = [
   { name="Yi Xing", email="blandilyte@gmail.com" },
-]
+]0
 description = "DSL to HTML conversion"
 readme = "README.md"
 requires-python = ">=3.0"
@@ -18,4 +18,4 @@ classifiers = [
 ]
 
 [project.urls]
-"Homepage" = "https://github.com/Crissium/python-dsl"
+"Homepage" = "https://github.com/Crissium/python-dsl"

src/build.cc

@@ -222,34 +222,34 @@ void builder::write_media(const node &n)
 
 	if (is_image(filename))
 	{
-		html_stream << "<img src=\"" << url_cache_root << filename << "\" alt=\"" << filename << "\"/>";
+		html_stream << "<img src=\"" << base_url_static_files << filename << "\" alt=\"" << filename << "\"/>";
 	}
 	else if (is_audio(filename))
 	{
 		if (audio_found)
 		{
-			html_stream << "<audio controls src=\"" << url_cache_root << filename << "\">" << filename << "</audio>";
+			html_stream << "<audio controls src=\"" << base_url_static_files << filename << "\">" << filename << "</audio>";
 		}
 		else
 		{
-			html_stream << "<audio controls autoplay src=\"" << url_cache_root << filename << "\">" << filename << "</audio>";
+			html_stream << "<audio controls autoplay src=\"" << base_url_static_files << filename << "\">" << filename << "</audio>";
 			audio_found = true;
 		}
 	}
 	else if (is_video(filename))
 	{
-		html_stream << "<video controls src=\"" << url_cache_root << filename << "\">" << filename << "</video>";
+		html_stream << "<video controls src=\"" << base_url_static_files << filename << "\">" << filename << "</video>";
 	}
 	else
 	{
-		html_stream << "<a href=\"" << url_cache_root << filename << "\">" << filename << "</a>";
+		html_stream << "<a href=\"" << base_url_static_files << filename << "\">" << filename << "</a>";
 	}
 }
 
 void builder::write_ref(const node &n)
 {
 	std::string headword = get_node_link(n);
-	html_stream << "<a href=\"" << url_lookup_root << headword << "\">" << headword << "</a>";
+	html_stream << "<a href=\"" << base_url_lookup << headword << "\">" << headword << "</a>";
 }
 
 void builder::write_url(const node &n)
@@ -351,9 +351,10 @@ void builder::node_to_html(const node &n)
 	}
 }
 
-builder::builder(const std::string &name_dict) : url_cache_root("/api/cache/" + name_dict + "/"),
-												 url_lookup_root("/api/lookup/" + name_dict + "/"),
-												 audio_found(false)
+builder::builder(const std::string &base_url_static_files, const std::string &base_url_lookup)
+	: base_url_static_files(base_url_static_files)
+	, base_url_lookup(base_url_lookup)
+	, audio_found(false)
 {
 }
 

src/dsl.h

@@ -94,8 +94,8 @@ class builder
 
 	static std::string get_node_link(const node &n);
 
-	const std::string url_cache_root;
-	const std::string url_lookup_root;
+	const std::string base_url_static_files;
+	const std::string base_url_lookup;
 
 	bool audio_found;
 
@@ -125,7 +125,7 @@ class builder
 public:
 	std::vector<std::string> resources_name;
 
-	builder(const std::string &name_dict);
+	builder(const std::string &base_url_static_files, const std::string &base_url_lookup);
 
 	std::string get_html(const node &root);
 };

src/dslmodule.cc

@@ -1,30 +1,31 @@
 #include <Python.h>
 #include "dsl.h"
 
-std::pair<std::string, std::vector<std::string>> to_html(const std::string &dsl, const std::string &name_dict)
+std::pair<std::string, std::vector<std::string>> to_html(const std::string &dsl, const std::string &base_url_static_files, const std::string &base_url_lookup)
 {
 	dom tree(dsl);
-	builder b(name_dict);
+	builder b(base_url_static_files, base_url_lookup);
 	std::string html = b.get_html(tree.root);
 	return std::make_pair(html, b.resources_name);
 }
 
 static PyObject *to_html_wrapper(PyObject *self, PyObject *args)
 {
 	const char *dsl;
-	const char *name_dict;
+	const char *base_url_static_files;
+	const char *base_url_lookup;
 
-	if (!PyArg_ParseTuple(args, "ss", &dsl, &name_dict))
+	if (!PyArg_ParseTuple(args, "sss", &dsl, &base_url_static_files, &base_url_lookup))
 	{
 		return NULL;
 	}
 
-	builder b(name_dict);
+	builder b(base_url_static_files, base_url_lookup);
 	std::string html;
 
 	Py_BEGIN_ALLOW_THREADS
 		dom tree(dsl);
-	html = b.get_html(tree.root);
+		html = b.get_html(tree.root);
 	Py_END_ALLOW_THREADS
 
 		PyObject *html_str = PyUnicode_DecodeUTF8(html.c_str(), html.length(), "strict");

src/parse.cc

@@ -537,7 +537,7 @@ dom::dom(const std::string &dsl_text)
 			text_node->text.push_back(ch);
 		}
 	}
-	catch (std::exception)
+	catch (std::exception const &)
 	{
 	}