From b404312686874e539b617d1f27ccbaa5a82936af Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Thu, 21 Oct 2021 15:38:10 -0400
Subject: Replace serdi with more fine-grained tools

Especially with the new functionality, the complexity of the command-line
interface alone was really becoming unmanageable.  The serdi implementation
also had the highest cyclomatic complexity of the entire codebase by a huge
margin.

So, take a page from the Unix philosophy and split serdi into several more
finely-honed tools that can be freely composed.  Though there is still
unfortunately quite a bit of option overlap between them due to the common
details of reading RDF, I think the resulting tools are a lot easier to
understand, both from a user and a developer perspective.
---
 tools/console.h | 104 +++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 100 insertions(+), 4 deletions(-)

(limited to 'tools/console.h')

diff --git a/tools/console.h b/tools/console.h
index 16f6fd14..cb227e8e 100644
--- a/tools/console.h
+++ b/tools/console.h
@@ -16,28 +16,108 @@
 
 #include "serd/serd.h"
 
+#include <stdbool.h>
+#include <stdint.h>
 #include <stdio.h>
 
+// Iterator over command-line options with support for BSD-style flag merging
+typedef struct {
+  char* const* argv; ///< Complete argument vector (from main)
+  int          argc; ///< Total number of arguments (from main)
+  int          a;    ///< Argument index (index into argv)
+  int          f;    ///< Flag index (offset in argv[arg])
+} OptionIter;
+
+// Options for the input or output syntax
+typedef struct {
+  SerdSyntax syntax;     ///< User-specified syntax, or empty
+  uint32_t   flags;      ///< SerdReaderFlags or SerdWriterFlags
+  bool       overridden; ///< True if syntax was explicitly given
+} SerdSyntaxOptions;
+
+// Options common to all command-line tools
+typedef struct {
+  const char*       base_uri;
+  const char*       out_filename;
+  size_t            block_size;
+  size_t            stack_size;
+  SerdSyntaxOptions input;
+  SerdSyntaxOptions output;
+} SerdCommonOptions;
+
+// Common "global" state of a command-line tool that writes data
+typedef struct {
+  SerdByteSink* out;
+  SerdWorld*    world;
+  SerdEnv*      env;
+  SerdWriter*   writer;
+} SerdTool;
+
+static inline bool
+serd_option_iter_is_end(const OptionIter iter)
+{
+  return iter.a >= iter.argc || iter.argv[iter.a][0] != '-' ||
+         !iter.argv[iter.a][iter.f];
+}
+
+static inline SerdStatus
+serd_option_iter_advance(OptionIter* const iter)
+{
+  if (!iter->argv[iter->a][++iter->f]) {
+    ++iter->a;
+    iter->f = 1;
+  }
+
+  return SERD_SUCCESS;
+}
+
+SerdStatus
+serd_tool_setup(SerdTool* tool, const char* program, SerdCommonOptions options);
+
+SerdStatus
+serd_tool_cleanup(SerdTool tool);
+
 void
 serd_set_stream_utf8_mode(FILE* stream);
 
-int
+SerdStatus
 serd_print_version(const char* program);
 
+SerdStatus
+serd_get_argument(OptionIter* iter, const char** argument);
+
+SerdStatus
+serd_get_size_argument(OptionIter* iter, size_t* argument);
+
 SerdStatus
 serd_set_input_option(SerdStringView   name,
                       SerdSyntax*      syntax,
                       SerdReaderFlags* flags);
 
+SerdStatus
+serd_parse_input_argument(OptionIter* iter, SerdSyntaxOptions* options);
+
 SerdStatus
 serd_set_output_option(SerdStringView   name,
                        SerdSyntax*      syntax,
                        SerdWriterFlags* flags);
 
+SerdStatus
+serd_parse_output_argument(OptionIter* iter, SerdSyntaxOptions* options);
+
+SerdStatus
+serd_parse_common_option(OptionIter* iter, SerdCommonOptions* opts);
+
+SerdEnv*
+serd_create_env(const char* program,
+                const char* base_string,
+                const char* out_filename);
+
 SerdSyntax
-serd_choose_input_syntax(SerdWorld*  world,
-                         SerdSyntax  requested,
-                         const char* filename);
+serd_choose_syntax(SerdWorld*        world,
+                   SerdSyntaxOptions options,
+                   const char*       filename,
+                   SerdSyntax        fallback);
 
 SerdByteSource*
 serd_open_input(const char* filename, size_t block_size);
@@ -47,3 +127,19 @@ serd_open_output(const char* filename, size_t block_size);
 
 SerdStatus
 serd_set_base_uri_from_path(SerdEnv* env, const char* path);
+
+SerdStatus
+serd_read_source(SerdWorld*        world,
+                 SerdCommonOptions opts,
+                 SerdEnv*          env,
+                 SerdSyntax        syntax,
+                 SerdByteSource*   in,
+                 const SerdSink*   sink);
+
+SerdStatus
+serd_read_inputs(SerdWorld*        world,
+                 SerdCommonOptions opts,
+                 SerdEnv*          env,
+                 intptr_t          n_inputs,
+                 char* const*      inputs,
+                 const SerdSink*   sink);
-- 
cgit v1.2.1