# This file is part of lyx2lyx
# -*- coding: utf-8 -*-
# Copyright (C) 2002-2011 Dekel Tsur <dekel@lyx.org>,
-# José Matos <jamatos@lyx.org>, Richard Heck <rgheck@comcast.net>
+# José Matos <jamatos@lyx.org>, Richard Kimberly Heck <rikiheck@lyx.org>
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
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
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_end_of_sequence(lines, i):
Find the end of the sequence of layouts of the same kind.
Considers nesting. If the last paragraph in sequence is nested,
- the position of the last \end_deeper is returned, else
- the position of the last \end_layout.
+ the position of the last \\end_deeper is returned, else
+ the position of the last \\end_layout.
is_in_inset(lines, i, inset, default=(-1,-1)):
Check if line i is in an inset of the given type.
get_containing_inset(lines, i):
Finds out what kind of inset line i is within. Returns a
- list containing what follows \begin_inset on the line
+ list containing what follows \\begin_inset on the line
on which the inset begins, plus the starting and ending line.
Returns False on any kind of error or if it isn't in an inset.
So get_containing_inset(document.body, i) might return:
the first element, in lines[start, end].
Return -1 on failure."""
+
if end == 0 or end > len(lines):
end = len(lines)
return default
return val.strip('"')
-bool_values = {True: ("true", "1"),
- False: ("false", "0")}
+
+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:
- token <bool_value>
+ `token` <bool_value>
- Return True if <bool_value> is 1 or "true", False if bool_value
+ 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)
- if val in bool_values[True]:
- return True
- if val in bool_values[False]:
- return False
- return default
+ return bool_values.get(val, default)
def set_bool_value(lines, token, value, start=0, end=0):
oldvalue = get_bool_value(lines, token, i, i+1)
if oldvalue is value:
return oldvalue
- # Use 0/1 or true/false?
+ # set to new value
if get_quoted_value(lines, token, i, i+1) in ('0', '1'):
- value_string = bool_values[value][1]
+ lines[i] = "%s %d" % (token, value)
else:
- value_string = bool_values[value][0]
- # set to new value
- lines[i] = "%s %s" % (token, value_string)
+ lines[i] = "%s %s" % (token, str(value).lower())
return oldvalue
def get_option_value(line, option):
- rx = option + '\s*=\s*"([^"]+)"'
+ rx = option + r'\s*=\s*"([^"]+)"'
rx = re.compile(rx)
m = rx.search(line)
if not m:
def set_option_value(line, option, value):
- rx = '(' + option + '\s*=\s*")[^"]+"'
+ rx = '(' + option + r'\s*=\s*")[^"]+"'
rx = re.compile(rx)
m = rx.search(line)
if not m:
return line
- return re.sub(rx, '\g<1>' + value + '"', line)
+ return re.sub(rx, r'\g<1>' + value + '"', line)
def del_token(lines, token, start=0, end=0):
def get_containing_inset(lines, i):
'''
Finds out what kind of inset line i is within. Returns a
- list containing (i) what follows \begin_inset on the line
+ list containing (i) what follows \\begin_inset on the line
on which the inset begins, plus the starting and ending line.
Returns False on any kind of error or if it isn't in an inset.
'''
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)
- 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:
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"]
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):
pars = 0
for j in range(ins[1], ins[2]):
m = re.match(r'\\begin_layout (.*)', lines[j])
- if m and get_containing_inset(lines, j)[0] == ins[0]:
+ if m and get_containing_inset(lines, j)[1] == ins[1]:
pars += 1
return pars
projects / features.git / blobdiff