From 8bcdacf1ce502e67f1373174bf50c894119ca6f9 Mon Sep 17 00:00:00 2001
From: Sengian <sengian1@gmail.com>
Date: Sat, 12 May 2012 20:59:59 +0200
Subject: [PATCH] RTFInput: Problem with old RTF bracket addition

---
 src/calibre/ebooks/rtf2xml/add_brackets.py | 57 ++++++++++++++--------
 1 file changed, 37 insertions(+), 20 deletions(-)

diff --git a/src/calibre/ebooks/rtf2xml/add_brackets.py b/src/calibre/ebooks/rtf2xml/add_brackets.py
index bec3ce3abc..1f37772c8f 100755
--- a/src/calibre/ebooks/rtf2xml/add_brackets.py
+++ b/src/calibre/ebooks/rtf2xml/add_brackets.py
@@ -101,6 +101,14 @@ class AddBrackets:
 
     def __in_body_func(self, line):
         """
+        Select what action to take in body:
+            1-At the end of the file close the braket if a bracket was opened
+            This happens if there is achange
+            2-If an open bracket is found the code inside is ignore
+            (written without modifications)
+            3-If an accepted control word is found put the line
+            in a buffer then chage state to after cw
+            4-Else simply write the line
         """
         if line == 'cb<nu<clos-brack<0001\n' and self.__open_bracket:
             self.__write_obj.write(
@@ -120,6 +128,10 @@ class AddBrackets:
 
     def __after_control_word_func(self, line):
         """
+        After a cw either add next allowed cw to temporary list or
+        change groupe and write it.
+        If the token leading to an exit is an open bracket go to
+        ignore otherwise goto in body
         """
         if self.__token_info in self.__accept:
             self.__temp_group.append(line)
@@ -135,42 +147,47 @@ class AddBrackets:
 
     def __write_group(self):
         """
+        Write a tempory group after accepted control words end
+        But this is mostly useless in my opinion as there is no list of rejected cw
+        This may be a way to implement future old rtf processing for cw
+        Utility: open a group to just put brackets but why be so complicated?
+        Scheme: open brackets, write cw then go to body and back with cw after 
         """
         if self.__open_bracket:
             self.__write_obj.write(
                 'cb<nu<clos-brack<0003\n'
                 )
             self.__open_bracket = False
-        inline_string = ''
-        the_keys = self.__inline.keys()
-        for the_key in the_keys:
-            value = self.__inline[the_key]
-            if value != 'false':
-                inline_string += '%s<nu<%s\n' % (the_key, value)
+
+        inline_string = ''.join(['%s<nu<%s\n' % (k, v) \
+                for k, v in self.__inline.iteritems() \
+                    if v != 'false'])
         if inline_string:
-            self.__write_obj.write('ob<nu<open-brack<0003\n')
-            self.__write_obj.write(inline_string)
+            self.__write_obj.write('ob<nu<open-brack<0003\n'
+                '%s' % inline_string)
             self.__open_bracket = True
         self.__temp_group = []
 
     def __change_permanent_group(self):
         """
-        use temp group to change permanent group
+        Use temp group to change permanent group
+        If the control word is not accepted remove it
+        What is the interest as it is build to accept only accepted cw
+        in __after_control_word_func?
         """
-        for line in self.__temp_group:
-            token_info = line[:16]
-            if token_info in self.__accept:
-                att = line[20:-1]
-                self.__inline[token_info] = att
+        self.__inline = {line[:16] : line[20:-1]\
+            for line in self.__temp_group\
+            # Is this really necessary?
+                if line[:16] in self.__accept}
+
 
     def __ignore_func(self, line):
         """
-        Don't add any brackets while inside of brackets RTF has already
-        added.
+        Just copy data inside of RTF brackets already here.
         """
         self.__write_obj.write(line)
-        if self.__token_info == 'cb<nu<clos-brack'and\
-            self.__cb_count == self.__ignore_count:
+        if self.__token_info == 'cb<nu<clos-brack'\
+            and self.__cb_count == self.__ignore_count:
             self.__state = 'in_body'
 
     def __check_brackets(self, in_file):
@@ -204,10 +221,10 @@ class AddBrackets:
             copy_obj = copy.Copy(bug_handler = self.__bug_handler)
             if self.__copy:
                 copy_obj.copy_file(self.__write_to, "add_brackets.data")
-            copy_obj.rename(self.__write_to, self.__file)
+            copy_obj.rename(self.__write_to, self.__file)  
         else:
             if self.__run_level > 0:
                 sys.stderr.write(
                     'Sorry, but this files has a mix of old and new RTF.\n'
                     'Some characteristics cannot be converted.\n')
-        os.remove(self.__write_to)
+        os.remove(self.__write_to)
\ No newline at end of file