Changeset 1682:cfc7a1a73805

Timestamp:

11/22/08 00:05:18 (7 weeks ago)

Author:

Ali Afshar <aafshar@…>

Parents:

1679:b24dbcc340fd, 1681:b6979d84d3f8

Message:

merged 270

Files:

• build.vel (deleted)
• pida.pidaproject (deleted)
• pida/core/document.py (modified) (19 diffs)

pida/core/document.py

@@ -82 +82 @@
 
     def __init__(self, boss, filename=None, project=None):
+        """
+        Create a new Document instance.
+        
+        @boss: boss this document belongs to
+        @filename: path to the file or None (unamed buffer)
+        @project: project this document belongs to
+        """
         self.boss = boss
         if filename is not None:
-            filename = os.path.realpath(filename)
-        self.filename = filename
+            self.filename = os.path.realpath(filename)
+        else:
+            self.filename = None
         self.project = project
         self.editor = None
@@ -108 +116 @@
 
     def clear(self):
+        """
+        Clear document caches
+        """
         self._str = None
         self._lines = None
@@ -171 +182 @@
     @property
     def stat(self):
+        """
+        Returns the stat of the current file
+        """
         try:
             return os.stat(self.filename)
@@ -178 +192 @@
     @cached_property
     def mimetype(self):
+        """
+        Returns the mimetype guessed from the file
+        """
         #FIXME: use doctypes
         typ, encoding = mimetypes.guess_type(self.filename)
@@ -188 +205 @@
     @property
     def filesize(self):
+        """
+        Filesize of Document
+        """
         return self.stat[stat.ST_SIZE]
 
@@ -210 +230 @@
     @property
     def markup_title(self):
-        """Returns a markup version of unicode"""
+        """
+        Returns a markup version of unicode
+        """
         if self.filename is None:
             if self.newfile_index > 1:
@@ -229 +251 @@
     @property
     def encoding(self):
+        """
+        Encoding of file
+        """
         self._load()
         # FIXME: if self.is_new we should run the _encode detection from
@@ -243 +268 @@
     @property
     def live(self):
+        """
+        Returns a boolean if the document is loaded in the editor
+        """
         # live indicates that this object has a editor instance which get_content
         #self.live = False
@@ -250 +278 @@
         return False
 
-    def get_content(self):
-        if hasattr(self.editor, 'get_content') and self.editor:
+    def get_content(self, live=True):
+        """
+        Returns the content of the document.
+        If live is true and the document is loaded into an editor the
+        content of the editor is returned
+        """
+        if live and hasattr(self.editor, 'get_content') and self.editor:
             return self.boss.editor.get_content(self.editor)
         self._load()
         return self._str
 
-    def set_content(self, value, flush=True):
+    def set_content(self, value, flush=True, live=True):
+        """
+        Sets the content of the document.
+        If live is True and the document is loaded, it's content is returned
+        """
         if hasattr(self.boss.editor, 'set_content') and self.editor:
             return self.boss.editor.set_content(self.editor, value)
@@ -269 +306 @@
 
     def flush(self):
+        """
+        Flush the buffer.
+        If editor has loaded this document, it's value
+        is fetched befor writing to disc
+        """
         if hasattr(self.editor, 'get_content') and self.editor:
             value = self.boss.editor.get_content(self.editor)
@@ -294 +336 @@
     @property
     def directory(self):
+        """
+        Directory name the Document is located in
+        """
         if self.is_new:
             return None
@@ -300 +345 @@
     @property
     def directory_basename(self):
+        """
+        Directory's name the Document is located in
+        """
         if self.is_new:
             return None
@@ -306 +354 @@
     @property
     def basename(self):
+        """
+        Basename of the file. It's actuall filename
+        """
         if self.is_new:
             return None
@@ -319 +370 @@
 
     def get_markup(self, markup_string=None, style=None):
+        """
+        Returns a markup version the Document designed for
+        beeing embedded in gtk views
+        """
         if markup_string is None:
             if self.project:
@@ -335 +390 @@
 
     def get_markup_tworow(self, style=None):
+        """
+        Two rowed version of above
+        """
         if self.project:
             mark = self.get_markup(self.markup_string_tworow_project)
@@ -359 +417 @@
     @property
     def project_name(self):
+        """
+        Name of Project or None
+        """
         if self.project is not None:
             return self.project.display_name
@@ -365 +426 @@
 
     def get_project_relative_path(self):
+        """
+        Returns the relative path to Project's root
+        """
         if self.filename is None:
             return None, None
@@ -379 +443 @@
     @property
     def is_new(self):
+        """
+        True if the Document is not associated to a filename
+        """
         return self.filename is None
 
@@ -401 +468 @@
 
     def append(self, line):
+        """
+        Add a line to the Document
+        """
         self._list.append(line)
         self._update_content_from_lines()