More polishing of counter dialog. Thanks to Jürgen for help.

[lyx.git] / lib / lyx2lyx / parser_tools.py

diff --git a/lib/lyx2lyx/parser_tools.py b/lib/lyx2lyx/parser_tools.py
index 06cb41df915dc2328c6ae6acb8a7e593ff6c3a00..44131e554e71696655922b0f2e4baaa03dbd540f 100644 (file)
--- a/lib/lyx2lyx/parser_tools.py
+++ b/lib/lyx2lyx/parser_tools.py
@@ -23,7 +23,7 @@ This module offers several free functions to help parse lines.
 More documentaton is below, but here is a quick guide to what
 they do. Optional arguments are marked by brackets.
 
 More documentaton is below, but here is a quick guide to what
 they do. Optional arguments are marked by brackets.
 

-find_token(lines, token, start[, end[, ignorews]]):
+find_token(lines, token[, start[, end[, ignorews]]]):

   Returns the first line i, start <= i < end, on which
   token is found at the beginning. Returns -1 if not
   found.
   Returns the first line i, start <= i < end, on which
   token is found at the beginning. Returns -1 if not
   found.


@@ -31,10 +31,10 @@ find_token(lines, token, start[, end[, ignorews]]):
   in whitespace do not count, except that there must be no
   extra whitespace following token itself.
 
   in whitespace do not count, except that there must be no
   extra whitespace following token itself.
 

-find_token_exact(lines, token, start[, end]):
+find_token_exact(lines, token[, start[, end]]]):

   As find_token, but with ignorews set to True.
 
   As find_token, but with ignorews set to True.
 

-find_tokens(lines, tokens, start[, end[, ignorews]]):
+find_tokens(lines, tokens[, start[, end[, ignorews]]]):

   Returns the first line i, start <= i < end, on which
   one of the tokens in tokens is found at the beginning.
   Returns -1 if not found.
   Returns the first line i, start <= i < end, on which
   one of the tokens in tokens is found at the beginning.
   Returns -1 if not found.


@@ -42,13 +42,16 @@ find_tokens(lines, tokens, start[, end[, ignorews]]):
   in whitespace do not count, except that there must be no
   extra whitespace following token itself.
 
   in whitespace do not count, except that there must be no
   extra whitespace following token itself.
 

-find_tokens_exact(lines, token, start[, end]):
+find_tokens_exact(lines, token[, start[, end]]):

   As find_tokens, but with ignorews True.
 
 find_token_backwards(lines, token, start):
 find_tokens_backwards(lines, tokens, start):
   As before, but look backwards.
 
   As find_tokens, but with ignorews True.
 
 find_token_backwards(lines, token, start):
 find_tokens_backwards(lines, tokens, start):
   As before, but look backwards.
 

+find_substring(lines, sub[, start[, end]]) -> int
+  As find_token, but sub may be anywhere in the line.
+

 find_re(lines, rexp, start[, end]):
   As find_token, but rexp is a regular expression object,
   so it has to be passed as e.g.: re.compile(r'...').
 find_re(lines, rexp, start[, end]):
   As find_token, but rexp is a regular expression object,
   so it has to be passed as e.g.: re.compile(r'...').


@@ -63,6 +66,7 @@ get_value(lines, token[, start[, end[, default[, delete]]]]):
   is stripped.) The final argument, default, defaults to "",
   and is what is returned if we do not find anything. So you
   can use that to set a default.
   is stripped.) The final argument, default, defaults to "",
   and is what is returned if we do not find anything. So you
   can use that to set a default.

+  If delete is True, then delete the line if found.

 
 get_quoted_value(lines, token[, start[, end[, default[, delete]]]]):
   Similar to get_value, but it will strip quotes off the
 
 get_quoted_value(lines, token[, start[, end[, default[, delete]]]]):
   Similar to get_value, but it will strip quotes off the


@@ -77,10 +81,17 @@ get_option_value(line, option):
 get_bool_value(lines, token[, start[, end[, default, delete]]]]):
   Like get_value, but returns a boolean.
 
 get_bool_value(lines, token[, start[, end[, default, delete]]]]):
   Like get_value, but returns a boolean.
 

-del_token(lines, token, start[, end]):
+set_bool_value(lines, token, value[, start[, end]]):
+  Find `token` in `lines[start:end]` and set to boolean value bool(`value`).
+  Return old value. Raise ValueError if token is not in lines.
+
+del_token(lines, token[, start[, end]]):

   Like find_token, but deletes the line if it finds one.
   Returns True if a line got deleted, otherwise False.
 
   Like find_token, but deletes the line if it finds one.
   Returns True if a line got deleted, otherwise False.
 

+  Use get_* with the optional argument "delete=True", if you want to
+  get and delete a token.
+

 find_beginning_of(lines, i, start_token, end_token):
   Here, start_token and end_token are meant to be a matching
   pair, like "\\begin_layout" and "\\end_layout". We look for
 find_beginning_of(lines, i, start_token, end_token):
   Here, start_token and end_token are meant to be a matching
   pair, like "\\begin_layout" and "\\end_layout". We look for


@@ -187,6 +198,8 @@ def find_token(lines, token, start=0, end=0, ignorews=False):
     whitespace are ignored, but there must be whitespace following
     token itself.
 
     whitespace are ignored, but there must be whitespace following
     token itself.
 

+    Use find_substring(lines, sub) to find a substring anywhere in `lines`.
+

     Return -1 on failure."""
 
     if end == 0 or end > len(lines):
     Return -1 on failure."""
 
     if end == 0 or end > len(lines):


@@ -217,6 +230,7 @@ def find_tokens(lines, tokens, start=0, end=0, ignorews=False):
     the first element, in lines[start, end].
 
     Return -1 on failure."""
     the first element, in lines[start, end].
 
     Return -1 on failure."""

+

     if end == 0 or end > len(lines):
         end = len(lines)
 
     if end == 0 or end > len(lines):
         end = len(lines)
 


@@ -239,14 +253,32 @@ def find_tokens_exact(lines, tokens, start=0, end=0):
     return find_tokens(lines, tokens, start, end, True)
 
 
     return find_tokens(lines, tokens, start, end, True)
 
 

-def find_re(lines, rexp, start=0, end=0):
-    """ find_re(lines, rexp, start[, end]) -> int
+def find_substring(lines, sub, start=0, end=0):
+    """ find_substring(lines, sub[, start[, end]]) -> int

 
 

-    Return the lowest line where rexp, a regular expression, is found
-    in lines[start, end].
+    Return the lowest line number `i` in [start, end] where
+    `sub` is a substring of line[i].

 
     Return -1 on failure."""
 
 
     Return -1 on failure."""
 

+    if end == 0 or end > len(lines):
+        end = len(lines)
+    for i in range(start, end):
+        if sub in lines[i]:
+                return i
+    return -1
+
+
+def find_re(lines, rexp, start=0, end=0):
+    """ find_re(lines, rexp[, start[, end]]) -> int
+
+    Return the lowest line number `i` in [start, end] where the regular
+    expression object `rexp` matches at the beginning of line[i].
+    Return -1 on failure.
+
+    Start your pattern with the wildcard ".*" to find a match anywhere in a
+    line. Use find_substring() to find a substring anywhere in the lines.
+    """

     if end == 0 or end > len(lines):
         end = len(lines)
     for i in range(start, end):
     if end == 0 or end > len(lines):
         end = len(lines)
     for i in range(start, end):


@@ -399,23 +431,42 @@ def get_quoted_value(lines, token, start=0, end=0, default="", delete=False):
     return val.strip('"')
 
 
     return val.strip('"')
 
 

+bool_values = {"true": True, "1": True,
+               "false": False, "0": False}
+

 def get_bool_value(lines, token, start=0, end=0, default=None, delete=False):
     """ get_bool_value(lines, token, start[[, end], default]) -> string
 
     Find the next line that looks like:
 def get_bool_value(lines, token, start=0, end=0, default=None, delete=False):
     """ get_bool_value(lines, token, start[[, end], default]) -> string
 
     Find the next line that looks like:

-      token bool_value
+      `token` <bool_value>

 
 

-    Returns True if bool_value is 1 or true and
-    False if bool_value is 0 or false
+    Return True if <bool_value> is 1 or "true", False if <bool_value>
+    is 0 or "false", else `default`.

     """
     """

-

     val = get_quoted_value(lines, token, start, end, default, delete)
     val = get_quoted_value(lines, token, start, end, default, delete)

+    return bool_values.get(val, default)

 
 

-    if val == "1" or val == "true":
-        return True
-    if val == "0" or val == "false":
-        return False
-    return default
+
+def set_bool_value(lines, token, value, start=0, end=0):
+    """Find `token` in `lines` and set to bool(`value`).
+
+    Return previous value. Raise `ValueError` if `token` is not in lines.
+
+    Cf. find_token(), get_bool_value().
+    """
+    i = find_token(lines, token, start, end)
+    if i == -1:
+        raise ValueError
+    oldvalue = get_bool_value(lines, token, i, i+1)
+    if oldvalue is value:
+        return oldvalue
+    # set to new value
+    if get_quoted_value(lines, token, i, i+1) in ('0', '1'):
+        lines[i] = "%s %d" % (token, value)
+    else:
+        lines[i] = "%s %s" % (token, str(value).lower())
+
+    return oldvalue

 
 
 def get_option_value(line, option):
 
 
 def get_option_value(line, option):


@@ -543,8 +594,9 @@ def is_in_inset(lines, i, inset, default=(-1,-1)):
       is_in_inset(document.body, i, "\\begin_inset Tabular")
     returns (-1,-1) if `i` is not within a "Tabular" inset (i.e. a table).
     If it is, then it returns the line on which the table begins and the one
       is_in_inset(document.body, i, "\\begin_inset Tabular")
     returns (-1,-1) if `i` is not within a "Tabular" inset (i.e. a table).
     If it is, then it returns the line on which the table begins and the one

-    on which it ends. Note that this pair will evaulate to
-    boolean True, so
+    on which it ends.
+    Note that this pair will evaulate to boolean True, so (with the optional
+    default value set to False)

       if is_in_inset(..., default=False):
     will do what you expect.
     """
       if is_in_inset(..., default=False):
     will do what you expect.
     """


@@ -586,12 +638,15 @@ def get_containing_inset(lines, i):
 
 def get_containing_layout(lines, i):
   '''
 
 def get_containing_layout(lines, i):
   '''

-  Finds out what kind of layout line i is within. Returns a
-  list containing what follows \begin_layout on the line
-  on which the layout begins, plus the starting and ending line
-  and the start of the paragraph (after all params). I.e, returns:
+  Find out what kind of layout line `i` is within.
+  Return a tuple

     (layoutname, layoutstart, layoutend, startofcontent)
     (layoutname, layoutstart, layoutend, startofcontent)

-  Returns False on any kind of error.
+  containing
+    * layout style/name,
+    * start line number,
+    * end line number, and
+    * number of first paragraph line (after all params).
+  Return `False` on any kind of error.

   '''
   j = i
   while True:
   '''
   j = i
   while True:


@@ -606,10 +661,13 @@ def get_containing_layout(lines, i):
   if endlay < i:
       return False
 
   if endlay < i:
       return False
 

-  lay = get_value(lines, "\\begin_layout", stlay)
-  if lay == "":
-      # shouldn't happen
-      return False
+  layoutname = get_value(lines, "\\begin_layout", stlay)
+  if layoutname == "": # layout style missing
+      # TODO: What shall we do in this case?
+      pass
+      # layoutname == "Standard" # use same fallback as the LyX parser:
+      # raise ValueError("Missing layout name on line %d"%stlay) # diagnosis
+      # return False # generic error response

   par_params = ["\\noindent", "\\indent", "\\indent-toggle", "\\leftindent",
                 "\\start_of_appendix", "\\paragraph_spacing", "\\align",
                 "\\labelwidthstring"]
   par_params = ["\\noindent", "\\indent", "\\indent-toggle", "\\leftindent",
                 "\\start_of_appendix", "\\paragraph_spacing", "\\align",
                 "\\labelwidthstring"]


@@ -618,7 +676,7 @@ def get_containing_layout(lines, i):
       stpar += 1
       if lines[stpar].split(' ', 1)[0] not in par_params:
           break
       stpar += 1
       if lines[stpar].split(' ', 1)[0] not in par_params:
           break

-  return (lay, stlay, endlay, stpar)
+  return (layoutname, stlay, endlay, stpar)

 
 
 def count_pars_in_inset(lines, i):
 
 
 def count_pars_in_inset(lines, i):