[!] 2017-01

[.^] "readme.txt" updated.
[^] Added ability to pass parameters to formatter.
[-] Rockspec dropped (moved to another repository).
[.^] Sync with current "workshop" functions library.

Author: Ian

#mechs/generic_file_converter.lua

@@ -1,7 +1,7 @@
-local default_loader = request('^.workshop.load_from.lua.serialize_table.lua_code')
+local default_loader = request('^.workshop.load_from.lua_table')
 
-local serialize_func = request('^.workshop.save_to.lua.serialize_table.lua_code')
-local serialize_func_params =
+local table_to_str = request('^.workshop.save_to.lua_table')
+local table_to_str_params =
   {
     serializer =
       {
@@ -13,7 +13,7 @@ local serialize_func_params =
 local default_saver =
   function(t)
     if is_table(t) then
-      return serialize_func(t, serialize_func_params)
+      return table_to_str(t, table_to_str_params)
     else
       return t
     end

lcf-5.1-0.rockspec

@@ -1,6 +1,13 @@
 local load_lua = request('workshop.load_from.lua')
 local pretty_lua = request('workshop.save_to.lua')
 
+local pretty_lua_options =
+  {
+    indent_chunk = '  ',
+    right_margin = 100,
+    max_text_width = 65,
+  }
+
 local convert = request('#mechs.generic_file_converter')
 return
   function(f_in_name, f_out_name)
@@ -14,7 +21,7 @@ return
           end,
         save =
           function(t)
-            return pretty_lua(t)
+            return pretty_lua(t, pretty_lua_options)
           end,
       }
     )

lua_reformat.lua

@@ -1,18 +1,73 @@
-Formats any valid lua 5.3 code.
+Description
 
-Main advantage is that it wraps code lines at right margin (default
-is 70th character in line). Efforts are made to represent code in more
-easy to understand form, not the shortest one.
+  Formats any valid lua 5.3 code.
+
+  Main advantage is that it wraps code lines to maintain readability.
+  Efforts are made to represent code in more easy to understand form,
+  not the shortest one.
+
+  (
+    This is a backport version for lua 5.1. Potentially it may
+    have more problems and rarely updated. This is done to make
+    tool available to most community who uses 5.1 for LuaJIT.
+  )
 
 Requirements
 
-  Sole requirement is lua5.3. Earlier versions will not work.
+  Sole requirement is lua v5.1.
+
+
+Installation
+
+  sudo luarocks install lcf
+
 
 Usage
 
-  lua.reformat <fIn> <fOut>
+  From command-line
+
+    lua.reformat <fIn> <fOut>
+
+
+  From lua interpreter
+
+    Suppose you have a string with lua code and wish to get another
+    string with formatted code.
 
----
+    do
+      local lua_code_str = 'do return end' -- < fill it
+
+      require('lcf.workshop.base')
+      local get_formatted_ast = request('lcf.workshop.load_from.lua')
+      local get_formatted_code = request('lcf.workshop.save_to.lua')
+
+      return get_formatted_code(get_formatted_ast(lua_code_str))
+    end
+
+
+    Passing formatting parameters
+
+      You may override default parameters by passing a table with
+      new values of changed parameters:
+
+      get_formatted_code(
+        get_formatted_ast(lua_code_str),
+        {
+          indent_chunk = '  ',
+          right_margin = 100,
+          max_text_width = 65,
+        }
+      )
+
+      <indent_chunk> is a string using for building one indent.
+        You may try '|..' to see it's effect.
+      <right_margin> limits length of line with indent. Setting it
+        makes sense for printring.
+      <max_text_width> limits length of line without indent, i.e.
+        length of text in line. Setting it makes sense for windowed
+        viewing in editor.
+
+--
 * Built on my own general strings parser,
   which uses my own lua syntax representation,
   produces AST (annotated syntax tree),
@@ -22,14 +77,16 @@ Usage
   and maintain indentation.
 
 * Currently comments are stripped from code. I'll add support
-  for them someday.
+  for them someday (or will not and explain why).
 
 * It uses local copy of my "workshop" code hive.
   Current version: https://github.com/martin-eden/workshop
 
 * See also https://github.com/martin-eden/contents
----
+
+--
 2016-08-16
 2017-01-03
 2017-01-18
 2017-01-22
+2017-01-28

readme.txt

@@ -5,11 +5,12 @@
   of it.
 ]]
 
-local formatter = request('formatter.interface')
+local formatter_class = request('formatter.interface')
 
 return
-  function(data_struc)
+  function(data_struc, options)
     assert_table(data_struc)
+    local formatter = new(formatter_class, options)
     formatter:init()
     local is_ok = formatter:process_node(data_struc)
     local result = formatter.printer:get_text()

workshop/compile/lua/formatter.lua

@@ -1,16 +1,6 @@
 return
   function(self)
-    self.indent_chunk = '  '
     self.printer.indent_chunk = self.indent_chunk
     self.printer:init()
     self.state_keeper:init()
-    self.max_text_width = 60
-    self.right_margin = 100
-    --[[
-      <max_text_width> limits length of line without indent, i.e.
-        length of text in line. Setting it makes sense for windowed
-        viewing in editor.
-      <right_margin> limits length of line with indent. Setting it
-        makes sense for printring.
-    ]]
   end

workshop/compile/lua/formatter/init.lua

@@ -1,10 +1,11 @@
 return
   {
-    right_margin = nil,
-    max_text_width = nil,
-    indent_chunk = nil,
-    printer = new(request('^.^.^.string.text_block.interface')),
-    state_keeper = new(request('state_keeper.interface')),
+    right_margin = 80,
+    max_text_width = 65,
+    indent_chunk = '  ',
+    printer = request('^.^.^.string.text_block.interface'),
+    state_keeper = request('state_keeper.interface'),
+
     init = request('init'),
 
     handlers = request('handlers.interface'),
@@ -22,3 +23,11 @@ return
 
     representation_is_allowed = request('representation_is_allowed'),
   }
+
+--[[
+  <max_text_width> limits length of line without indent, i.e.
+    length of text in line. Setting it makes sense for windowed
+    viewing in editor.
+  <right_margin> limits length of line with indent. Setting it
+    makes sense for printring.
+]]

workshop/compile/lua/formatter/interface.lua

@@ -0,0 +1,4 @@
+return
+  function(self)
+    return self.serializer:get_result()
+  end

workshop/compile/lua/serialize_table/lua_code/get_result.lua

@@ -1,10 +1,13 @@
 return
   {
-    serialize = request('serialize'),
-
-    init = request('init'),
     node_recs = {},
     serializer = request('^.lua_table.interface'),
+
     put_qualified_key = request('put_qualified_key'),
     serialize_subtable = request('serialize_subtable'),
+
+    init = request('init'),
+
+    serialize = request('serialize'),
+    get_result = request('get_result'),
   }

workshop/compile/lua/serialize_table/lua_code/interface.lua

@@ -34,7 +34,7 @@ local may_print_inline =
 ]]
 
 return
-  function(self, root, a_params)
+  function(self, root)
     local assembly_order
     local dfs_params =
       {

workshop/compile/lua/serialize_table/lua_code/serialize.lua

@@ -0,0 +1,4 @@
+return
+  function(self)
+    return self.string_adder:get_result()
+  end

workshop/compile/lua/serialize_table/lua_table/get_result.lua

@@ -1,14 +1,18 @@
 return
   {
-    serialize = request('serialize'),
-
-    init = request('init'),
     always_index_keys = false,
+    initial_deep = 0,
+
     name_giver = request('^.^.^.^.handy_mechs.name_giver'),
     table_iterator = request('^.^.^.^.table.ordered_pass'),
     string_adder = request('^.^.^.^.handy_mechs.string_adders.array'),
     token_giver = request('^.^.token_givers.any'),
     quote_string = request('^.^.quote_string'),
     serialize_key = request('serialize_key'),
     serialize_key_value = request('serialize_key_value'),
+
+    init = request('init'),
+
+    serialize = request('serialize'),
+    get_result = request('get_result'),
   }

workshop/compile/lua/serialize_table/lua_table/interface.lua

@@ -1,5 +1,6 @@
 return
   function(self, node, deep, parent_type)
+    deep = deep or self.initial_deep
     local string_adder = self.string_adder
     local token = self.token_giver
     local quote_string = self.quote_string

workshop/compile/lua/serialize_table/lua_table/serialize.lua

@@ -0,0 +1 @@
+return request('lua.serialize_table.lua_code')

workshop/load_from/lua_table.lua

@@ -1,6 +1,6 @@
 local run_formatter = request('^.compile.lua.formatter')
 
 return
-  function(data_struc)
-    return run_formatter(data_struc)
+  function(data_struc, options)
+    return run_formatter(data_struc, options)
   end

workshop/save_to/lua.lua

@@ -1,13 +1,13 @@
 -- Dumps table to lua code which recreates table.
 
-local override_params = request('^.^.^.handy_mechs.override_params')
-local default_params = request('^.^.^.compile.lua.serialize_table.lua_code.interface')
+local table_serializer_class =
+  request('^.^.^.compile.lua.serialize_table.lua_code.interface')
 
 return
-  function(value, a_params)
-    assert_table(value)
-    local object = override_params(default_params, a_params)
-    object:init()
-    object:serialize(value)
-    return object.serializer.string_adder:get_result()
+  function(t, options)
+    assert_table(t)
+    local table_serializer = new(table_serializer_class, options)
+    table_serializer:init()
+    table_serializer:serialize(t)
+    return table_serializer:get_result()
   end

workshop/save_to/lua/serialize_table/lua_code.lua

@@ -0,0 +1 @@
+return request('lua.serialize_table.lua_code')