From 744e3a488544e158c510ddafc1e9b38fb75d0fd6 Mon Sep 17 00:00:00 2001
From: Lamisator <marius.kloeck@antwire.net>
Date: Fri, 11 Aug 2017 02:07:41 +0200
Subject: [PATCH] Added comments

---
 src/editorUI.py | 69 ++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 60 insertions(+), 9 deletions(-)

diff --git a/src/editorUI.py b/src/editorUI.py
index e63b013..fb15c21 100644
--- a/src/editorUI.py
+++ b/src/editorUI.py
@@ -1,9 +1,10 @@
-import urwid
-from lineWalker import LineWalker
 import uuid
 from time import sleep
+
+import urwid
+
 import mainUI
-import pdb
+from lineWalker import LineWalker
 
 class EditorUI(object):
 
@@ -13,8 +14,16 @@ class EditorUI(object):
 
         self.filename = filename
 
+        # Default footer, showing possible key sequences
         self.default_footer = urwid.AttrWrap(urwid.Text("<Alt + y> Save as |  <Alt + q> Close"), "standard")
+        
+        # Text field for new filemes. Defining it here and seperately, so we may access it later
+        self.filename_field = urwid.Edit("Enter new filename: ")
 
+        # Footer shown during filename selection
+        self.filename_footer = urwid.AttrWrap(self.filename_field, "filename")
+
+        # Defining view components
         self.walker = LineWalker(filename)
         self.content = urwid.ListBox(self.walker)
 
@@ -26,68 +35,104 @@ class EditorUI(object):
 
     def open(self, loop = None, callback = None, quicknote = False):
         
+
+
+
+        # If we are edting a (new) quicknote, show this header
         if quicknote:
             self.central_frame.set_header(urwid.AttrWrap(urwid.Text("Notology Quicknote\n" + self.filename, align = "center"), "header"))
 
+        # Remember the callback function (if any) we got, so we may return to the last view, once we have finished our editing
         self.callback = callback
+
+
         self.palette = [("standard", "light blue", "black"),
                         ("warning", "yellow", "black"),
                         ("header", "black", "dark blue")]
+        
+        # Check if the UI is fresh by checking if a loop has been passed. If not, create a new one, otherwise use the existing one
         fresh = False
         if loop == None:
             self.loop = urwid.MainLoop(self.central_frame, self.palette, unhandled_input = self.keypress_handler)
             fresh = True
         else:
+            # Update the existing loop with the attributes we would otherwise have set in the above constructor
             loop.widget = self.central_frame
+            
             loop.unhandled_input = self.keypress_handler
+            # We can't just do loop.palette = [...]! We have to 'register' our local palette. 
             loop.screen.register_palette(self.palette)
-            loop.draw_screen()
+
+            # This is our new loop! Remember it 
             self.loop = loop
 
+            # Use our new loop to redraw the screen, as it is running already
+            self.loop.draw_screen()
+
         if fresh:
+            # If this loop is new, we have to start it first. Duh!
             self.loop.run()
         return 0
 
     def keypress_handler(self, key):
-        
-        if key == "meta q":
+        # What we're gonna do, if we encounter any keystrokes
+
+        if key == "meta q":    
+            # Quit the editor. If we have no callback function, exit the main loop and thus quit the program. Else, call the callback function and "go back"
             if not self.callback:
-                raise urwid.ExitMainLoop()
+                self.exit_program()
             else:
-                #mainUI.MainUI().open(self.loop)
                 self.callback(self.loop)
-                
+        
         elif key == "meta y":
+            # Save the file
             self.save(self.filename, verbose = True)
     
+        
         elif key == "delete":
             # delete at end of line
             self.walker.combine_focus_with_next()
+
         elif key == "backspace":
             # backspace at beginning of line
             self.walker.combine_focus_with_prev()
+
         elif key == "enter":
             # start new line
             self.walker.split_focus()
             # move the cursor to the new line and reset pref_col
             self.loop.process_input(["down", "home"])
         elif key == "right":
+            # Check if there is a char right to the cursor, if yes, move there
             w, pos = self.walker.get_focus()
             w, pos = self.walker.get_next(pos)
             if w:
                 self.listbox.set_focus(pos, 'above')
                 self.loop.process_input(["home"])
+
         elif key == "left":
+            # Check if there is a char left to the cursor, if yes, move there
             w, pos = self.walker.get_focus()
             w, pos = self.walker.get_prev(pos)
             if w:
                 self.listbox.set_focus(pos, 'below')
                 self.loop.process_input(["end"])
+
         else:
+            # Everything else is fine as well
             return
 
         return True
     
+
+
+    def keypress_handler_filename(self, key):
+        # A dedicated keypress handler for the filename text field
+
+        if key == "enter":
+            # If return is hit, we are finished here
+            self.filename = self.filename_field.get_edit_text()
+
     def save(self, save_filename, verbose = False):
         walker = self.walker
         lines = []
@@ -115,6 +160,12 @@ class EditorUI(object):
             sleep(2)
             self.central_frame.footer = self.default_footer
 
+
+    def exit_program(self):
+
+        # Exit this program
+        raise urwid.ExitMainLoop()
+
 def re_tab(s):
     """Return a tabbed string from an expanded one."""
     l = []