some fixes for verbatim commands

Author: phfaist

flm/feature/headings.py

@@ -107,8 +107,8 @@ def recompose_pure_latex(self, node, recomposer):
 
         heading_macroname = node.macroname
 
-        recopt_cells = recomposer.get_options('headings')
-        heading_macroname_mapping = recopt_cells.get('macroname_mapping', None)
+        recopt_headings = recomposer.get_options('headings')
+        heading_macroname_mapping = recopt_headings.get('macroname_mapping', None)
         if heading_macroname_mapping:
             if heading_macroname in heading_macroname_mapping:
                 heading_macroname = heading_macroname_mapping[heading_macroname]

flm/feature/verbatim.py

@@ -1,3 +1,5 @@
+import re
+
 from pylatexenc.latexnodes import ParsedArgumentsInfo
 from pylatexenc.latexnodes import parsers as latexnodes_parsers
 from pylatexenc.latexnodes import nodes as latexnodes_nodes
@@ -45,12 +47,11 @@ def make_body_parser(self, token, nodeargd, arg_parsing_state_delta):
             environment_name=environment_name
         )
 
-    def render(self, node, render_context):
 
-        # environment_node_name = None
+    def _get_verbatim_contents_info(self, node):
 
         verbatim_lang = None
-
+        verbatim_contents = None
         is_inline = False
         is_environment = False
 
@@ -89,6 +90,23 @@ def render(self, node, render_context):
             if 'verbatim_lang' in node_args:
                 verbatim_lang = node_args['verbatim_lang'].get_content_as_chars()
 
+        return {
+            'is_inline': is_inline,
+            'is_environment': is_environment,
+            'verbatim_contents': verbatim_contents,
+            'verbatim_lang': verbatim_lang
+        }
+
+    def render(self, node, render_context):
+
+        # environment_node_name = None
+
+        verbatim_info = self._get_verbatim_contents_info(node)
+        is_inline = verbatim_info['is_inline']
+        is_environment = verbatim_info['is_environment']
+        verbatim_contents = verbatim_info['verbatim_contents']
+        verbatim_lang = verbatim_info['verbatim_lang']
+
         annotations = self.annotations or []
 
         if self.verbatimtype is not None:
@@ -108,6 +126,36 @@ def render(self, node, render_context):
             annotations=annotations,
         )
 
+    def recompose_pure_latex(self, node, recomposer):
+
+        recopt_verbatim = recomposer.get_options('verbatim')
+        use_fvextra = recopt_verbatim.get('use_fvextra', None)
+
+        if not use_fvextra:
+            return False # ‘False’ means fall back onto standard recomposing method
+        
+        verbatim_info = self._get_verbatim_contents_info(node)
+        is_inline = verbatim_info['is_inline']
+        is_environment = verbatim_info['is_environment']
+        verbatim_contents = verbatim_info['verbatim_contents']
+        verbatim_lang = verbatim_info['verbatim_lang']
+
+        if is_environment:
+            return False # use standard method for environments
+
+        recomposer.ensure_latex_package('fvextra')
+
+        content_escaped = re.sub(r'[^a-zA-Z0-9]', lambda m: '\\'+m.group(), verbatim_contents)
+
+        recomposed = (
+            r'\EscVerb[formatcom=\flmFmtVRB{'+node.macroname+r'}]{'
+            + content_escaped
+            + '}'
+        )
+
+        return recomposed
+
+
     # FLM-doc
 
     def get_flm_doc(self):

flm/flmrecomposer/purelatex.py

@@ -463,9 +463,20 @@ def recompose_delimited_nodelist(self, delimiters, nodelist, n):
 \providecommand\flmInlineVerbatimFormatDefault[1]{#1}
 
 
-\def\verba{\flmInlineVerb{\itshape}{}}
-\def\verbtext{\flmInlineVerb{}{}}
-\def\verbcode{\flmInlineVerb{\ttfamily}{}}
+\def\flmFmtVRBverba{\itshape}
+\def\flmFmtVRBverbtext{}
+\def\flmFmtVRBverbcode{\ttfamily}
+\def\flmFmtVRB#1{%
+  \ifcsname flmFmtVRB#1\endcsname
+    \csname flmFmtVRB#1\endcsname
+  \else
+    \flmFmtVRBverbcode
+  \fi
+}
+
+\def\verba{\flmInlineVerb{\flmFmtVRBverba}{}}
+\def\verbtext{\flmInlineVerb{\flmFmtVRBverbtext}{}}
+\def\verbcode{\flmInlineVerb{\flmFmtVRBverbcode}{}}
 
 
 """

flm/fragmentrenderer/latex.py

@@ -196,6 +196,7 @@ def render_verbatim(self, value, render_context, *,
                         is_block_level=False, annotations=None, target_id=None):
         if 'verbatimcode' in annotations:
             return r'\begin{verbatim}' + '\n' + value + r'\end{verbatim}'
+        # TODO: Maybe provide an interface to use \EscVerb here?? (cf fvextra latex package)
         # what to do with annotations / target_id ??
         if self.latex_wrap_verbatim_macro:
             return "\\" + self.latex_wrap_verbatim_macro + "{" + self.latexescape(value) + "}"
@@ -615,6 +616,9 @@ def collect_graphics_resource(self, graphics_resource, render_context):
         return graphics_resource.src_url, whoptc
 
 
+    cells_max_width_latexdim = r'0.96\linewidth'
+    cells_render_method = 'fit_width_test'
+
     def render_cells(self, cells_model, render_context, target_id=None,
                      render_cell_nodelist_contents_fn=None):
 
@@ -717,44 +721,94 @@ def render_cells(self, cells_model, render_context, target_id=None,
 
             stab_contents += '&'.join(stab_rowitems) + '\\\\' + '\n'
 
-        s = (
-            r'\flmCellsBeginCenter' + '\n'
+        def _typeset_table_contents(raw_args=None, colspec_one=None):
+            if raw_args is not None:
+                tblrargs = raw_args
+            else:
+                tblrargs = r'colspec={' + (colspec_one * tabwidth) + r'}'
+            return (
+                r'\begin{tblr}{' + tblrargs + r',' + '\n'
+                + r'  hspan=minimal'
+                + cell_spans_styles
+                + "".join([ ",\n  hline{"+rownrng+"}={"+colnrng+"}{"+lsty+"}"
+                             for (rownrng, colnrng, lsty) in cell_hlines ])
+                + "".join([ ",\n  vline{"+colnrng+"}={"+rownrng+"}{"+lsty+"}"
+                             for (rownrng, colnrng, lsty) in cell_vlines ])
+                + r'}%' + '\n'
+                + r'\toprule'
+                + '\n'
+                + stab_contents
+                + r'\bottomrule' + '\n'
+                + r'\end{tblr}%' + '\n'
+            )
+
+        if self.cells_render_method == 'simple':
+            s = (
+                r'\flmCellsBeginCenter' + '\n'
+                + _typeset_table_contents(colspec_one='c')
+                + r'\flmCellsEndCenter '
+            )
+            return s
+        
+        if self.cells_render_method == 'fit_width_test':
+            # Hack for automatic width detection -- typeset table once with 'c'
+            # column types; if the width exceeds a maximum set width
+            # (0.96\linewidth), then re-typeset the table with 'X[-1]' column
+            # types.  Store the typesetting code in a macro to be more compact.
+            s = (
+                r'\flmCellsBeginCenter' + '\n'
+                + r'\long\def\flmTempTypesetThisTable#1{%' + '\n'
+                + _typeset_table_contents(raw_args='#1')
+                + r'}%' + '\n'
+            )
+            # now, the code to automatically detect the correct width
+            s += (
+                r'\def\flmTmpMaxW{\dimexpr ' + self.cells_max_width_latexdim
+                                             + r'\relax}%' + '\n'
+                + r'\setbox0=\hbox{\flmTempTypesetThisTable{colspec={'
+                    + ('c' * tabwidth) + r'}}}%' + '\n'
+                + r'\ifdim\wd0<\flmTmpMaxW\relax' + '\n'
+                + r'  \leavevmode\box0 ' + '\n'
+                + r'\else' + '\n'
+                + r'  \flmTempTypesetThisTable{width=\flmTmpMaxW,colspec={'
+                    + ('X[-1]' * tabwidth) + r'}}' + '\n'
+                + r'\fi' + '\n'
+            )
+            s += r'\flmCellsEndCenter '
+            return s
+
+        if self.cells_render_method == 'fit_width_test_dupl':
             # Hack for automatic width detection -- typeset table once with 'c'
             # column types; if the width exceeds a maximum set width
             # (0.96\linewidth), then re-typeset the table with 'X[-1]' column
             # types.
-            r'\long\def\flmTempTypesetThisTable#1{%' + '\n'
-            r'\begin{tblr}{#1,' + '\n' + r'  hspan=minimal'
-            + cell_spans_styles
-            + "".join([ ",\n  hline{"+rownrng+"}={"+colnrng+"}{"+lsty+"}"
-                         for (rownrng, colnrng, lsty) in cell_hlines ])
-            + "".join([ ",\n  vline{"+colnrng+"}={"+rownrng+"}{"+lsty+"}"
-                         for (rownrng, colnrng, lsty) in cell_vlines ])
-            + r'}' + '\n'
-            + r'\toprule'
-            + '\n'
-        )
-        s += stab_contents
-        s += r'\bottomrule' + '\n'
-        s += r'\end{tblr}%' + '\n'
-        s += r'}%' + '\n'
-        # now, the code to automatically detect the correct width
-        s += (
-            r'\def\flmTmpMaxW{\dimexpr ' + self.max_table_width_latexdim + r'\relax}%' + '\n'
-            + r'\setbox0=\hbox{\flmTempTypesetThisTable{colspec={'
-                + ('c' * tabwidth) + r'}}}%' + '\n'
-            + r'\ifdim\wd0<\flmTmpMaxW\relax' + '\n'
-            + r'  \leavevmode\box0 ' + '\n'
-            + r'\else' + '\n'
-            + r'  \flmTempTypesetThisTable{width=\flmTmpMaxW,colspec={'
-                + ('X[-1]' * tabwidth) + r'}}' + '\n'
-            + r'\fi' + '\n'
-        )
-        s += r'\flmCellsEndCenter '
+            #
+            # But paste the code to typeset the table *TWICE* so that we do not
+            # have to use this ugly \def hack.  (Originally I thought that this
+            # would enable us to use fragile commands like \verba{...} (like
+            # \verb+...+) inside the table contents.  But it doesn't work,
+            # probably because of tblr itself.)
+            s = (
+                r'\flmCellsBeginCenter' + '\n'
+                + r'\def\flmTmpMaxW{\dimexpr ' + self.cells_max_width_latexdim
+                                               + r'\relax}%' + '\n'
+                + r'\setbox0=\hbox\bgroup'
+                + _typeset_table_contents(colspec_one='c')
+                + r'\egroup' + '\n'
+                + r'\ifdim\wd0<\flmTmpMaxW\relax' + '\n'
+                + r'  \leavevmode\box0 ' + '\n'
+                + r'\else' + '\n'
+                # Failed to typeset the table in the available width, try
+                # variable sizing instead.
+                +   _typeset_table_contents(colspec_one='X[-1]')
+                + r'\fi' + '\n'
+                + r'\flmCellsEndCenter '
+            )
+            return s
+
+        raise ValueError("Invalid cells_render_method: "+repr(self.cells_render_method))
 
-        return s
 
-    max_table_width_latexdim = r'0.96\linewidth'
 
 # ------------------
 

playground/mydraftforatable3.flm

@@ -5,6 +5,18 @@ flm:
     comment_start: '%%'
   features:
     'flm.feature.cells.FeatureCells': true
+
+  renderer:
+    latex:
+      #cells_render_method: 'simple'
+      cells_render_method: 'fit_width_test'
+      #cells_render_method: 'fit_width_test_dupl'
+
+  workflow_config:
+    flmlatex:
+      recomposer_options:
+        verbatim:
+          use_fvextra: True
 #$
 ---
 
@@ -120,10 +132,6 @@ A & B & C \\
 
 
 
-
-
-
-
 \begin{cells}
 \celldata<H c>{ One Heading & Two Headings & Three Headings }
 \celldata<c>[-]{
@@ -133,3 +141,11 @@ A & B this is a really long cell with tons of content! We can add more content a
 \cell<green>{X}
 \cell<yellow>[\merge{+2}]{YZ}
 \end{cells}
+
+
+
+\begin{cells}
+\celldata<H c>{One & Two}
+\celldata<l>{Hi there & \verba{test_fragile_command} }
+\end{cells}
+