Changeset 59d556541d6603f37383223706bde8a4c5b11f47

Timestamp:

01/06/07 23:33:53 (6 years ago)

Author:

Philipp Kern <phil@…>

Parents:

a70a4d03e72646528ab3a70b148d14e6fe390d4d

Children:

33a22c5cf1a312bedace4f3e4dec3117cfceb221

git-committer:

Philipp Kern <phil@0x539.de> / 2007-01-06T22:33:53Z+0000

Message:

[project @ User colourising]

Original author: Armin Burgmeier <armin@…>
Date: 2005-05-07 19:07:20+00:00

Files:

• TODO (modified) (1 diff)
• inc/document.hpp (modified) (5 diffs)
• src/document.cpp (modified) (8 diffs)
• src/folder.cpp (modified) (6 diffs)

TODO

@@ -5 +5 @@
  * Opening large documents is _really_ slow on win32's timer implementation
  * On connection loss: give a chance to save everything
- * User colourising 
+ * Gobby sometimes segfaults on exit
 
 Important:
  * Compensate changes made by others by scrolling appropriately; the current
    position should not change
+ * User colourising does not always repaint correctly
 
 Normal:

inc/document.hpp

@@ -46 +46 @@
         obby::document& get_document();
 
-        // Statusbar information
+        /** Writes the current cursor position into row and col.
+         */
         void get_cursor_position(unsigned int& row, unsigned int& col);
+
+        /** Returns the amount of unsynced operations in this document.
+         */
         unsigned int get_unsynced_changes_count() const;
+
+        /** Returns the currently selected Gtk::SourceLanguage.
+         */
 #ifdef WITH_GTKSOURCEVIEW
         Glib::RefPtr<Gtk::SourceLanguage> get_language() const;
@@ -58 +65 @@
         signal_update_type update_event() const;
 
+        /** Calls from the folder.
+         */
+        void obby_user_join(obby::user& user);
+        void obby_user_part(obby::user& user);
+
 protected:
+        /** Obby signal handlers.
+         */
+        void on_obby_insert(const obby::insert_record& record);
+        void on_obby_delete(const obby::delete_record& record);
+
+        /** TextBuffer signal handlers.
+         */
         void on_insert_before(const Gtk::TextBuffer::iterator& begin,
                               const Glib::ustring& text,
@@ -65 +84 @@
                              const Gtk::TextBuffer::iterator& end);
 
-        void on_obby_insert(const obby::insert_record& record);
-        void on_obby_delete(const obby::delete_record& record);
-
-        void on_insert_after(const Gtk::TextBuffer::iterator& begin,
+        void on_insert_after(const Gtk::TextBuffer::iterator& end,
                              const Glib::ustring& text,
                              int bytes);
@@ -74 +90 @@
                             const Gtk::TextBuffer::iterator& end);
 
+        /** Cursor position changed signal hanlder.
+         */
         void on_cursor_changed(const Gtk::TextBuffer::iterator& location,
                                const Glib::RefPtr<Gtk::TextBuffer::Mark>& mark);
+
+        /** Marks the given part of the text as written by <em>user</em>.
+         */
+        void update_user_colour(const Gtk::TextBuffer::iterator& begin,
+                                const Gtk::TextBuffer::iterator& end,
+                                const obby::user& user);
 
         obby::document& m_doc;
@@ -95 +119 @@
         
         signal_update_type m_signal_update;
+private:
+        /** Handler for update_user_colour(): It removes the given tag in
+         * the given range if it is a gobby-user-tag.
+         */
+        void on_remove_user_colour(Glib::RefPtr<Gtk::TextBuffer::Tag> tag,
+                                   const Gtk::TextBuffer::iterator& begin,
+                                   const Gtk::TextBuffer::iterator& end);
+
 };
 

src/document.cpp

@@ -18 +18 @@
 
 #include <obby/client_document.hpp>
+#include <obby/host_document.hpp>
+#include <obby/client_buffer.hpp>
+#include <obby/host_buffer.hpp>
 #include "document.hpp"
 #include "folder.hpp"
 
+#include <iostream>
 Gobby::Document::Document(obby::document& doc, const Folder& folder)
  : Gtk::ScrolledWindow(), m_doc(doc), m_folder(folder), m_editing(true)
@@ -54 +58 @@
         buf->set_highlight(true);
 #endif
+
+        // Insert users from user table to insert users that have already
+        // left the obby session.
+        const obby::buffer& obbybuf = doc.get_buffer();
+        const obby::user_table& user_table = doc.get_buffer().get_user_table();
+        for(obby::user_table::user_iterator iter = user_table.user_begin();
+            iter != user_table.user_end();
+            ++ iter)
+        {
+                // Create new tag
+                Glib::RefPtr<Gtk::TextBuffer::Tag> tag =
+                        buf->create_tag("gobby_user_" + iter->get_name() );
+
+                // Build user color
+                Gdk::Color color;
+                color.set_red(iter->get_red() * 65535 / 255);
+                color.set_green(iter->get_green() * 65535 / 255);
+                color.set_blue(iter->get_blue() * 65535 / 255);
+
+                // Assign color to tag
+                tag->property_background_gdk() = color;
+        }
 
         // Textbuffer signal handlers
@@ -75 +101 @@
         // Set initial text
         buf->set_text(doc.get_whole_buffer() );
+
+        // Set initial authors
+        for(unsigned int i = 0; i < doc.get_line_count(); ++ i)
+        {
+                // Get current line
+                const obby::line& line = doc.get_line(i);
+                obby::line::author_iterator prev = line.author_begin();
+                obby::line::author_iterator cur = prev;
+
+                // Iterate through it's authors list
+                for(++ cur; prev != line.author_end(); ++ cur)
+                {
+                        // Get current user
+                        const obby::user_table::user* user = prev->author;
+                        // user should never be NULL...
+                        if(user == NULL) continue;
+
+                        // Get the range to highlight
+                        obby::line::size_type endpos;
+                        if(cur != line.author_end() )
+                                endpos = cur->position;
+                        else
+                                endpos = line.length();
+
+                        Gtk::TextBuffer::iterator begin =
+                                buf->get_iter_at_line_index(i, prev->position);
+                        Gtk::TextBuffer::iterator end =
+                                buf->get_iter_at_line_index(i, endpos);
+
+                        // Apply corresponding tag
+                        buf->apply_tag_by_name(
+                                "gobby_user_" + user->get_name(),
+                                begin,
+                                end
+                        );
+
+                        prev = cur;
+                }
+        }
+
         m_editing = false;
         
@@ -113 +179 @@
         const Gtk::TextBuffer::iterator iter = mark->get_iter();
 
-        // Read line and column
+        // Read line and column from iterator
         row = iter.get_line();
         col = iter.get_line_offset();
@@ -136 +202 @@
 }
 #endif
+
+void Gobby::Document::obby_user_join(obby::user& user)
+{
+        // Build tag name for this user
+        Glib::ustring tag_name = "gobby_user_" + user.get_name();
+
+        // Find already existing tag
+        Glib::RefPtr<Gtk::TextBuffer> buffer = m_view.get_buffer();
+        Glib::RefPtr<Gtk::TextBuffer::TagTable> tag_table =
+                buffer->get_tag_table();
+        Glib::RefPtr<Gtk::TextBuffer::Tag> tag = tag_table->lookup(tag_name);
+
+        // Create new tag, if it doesn't exist
+        if(!tag)
+                tag = buffer->create_tag(tag_name);
+
+        // Build color
+        Gdk::Color color;
+        color.set_red(user.get_red() * 65535 / 255);
+        color.set_green(user.get_green() * 65535 / 255);
+        color.set_blue(user.get_blue() * 65535 / 255);
+
+        // Set/Update color
+        tag->property_background_gdk() = color;
+}
+
+void Gobby::Document::obby_user_part(obby::user& user)
+{
+}
 
 void Gobby::Document::on_insert_before(const Gtk::TextBuffer::iterator& begin,
@@ -180 +275 @@
         m_editing = true;
 
+        // Get textbuffer
         Glib::RefPtr<Gtk::TextBuffer> buffer = m_view.get_buffer();
 
+        // Translate position to row/column
         unsigned int row, col;
         m_doc.position_to_coord(record.get_position(), row, col);
-        buffer->insert(
+
+        // Find obby::user that inserted the text
+        obby::user* user = m_doc.get_buffer().find_user(record.get_from() );
+        assert(user != NULL);
+
+        // Insert text
+        Gtk::TextBuffer::iterator end = buffer->insert(
                 buffer->get_iter_at_line_index(row, col),
                 record.get_text()
         );
 
+        // Colourize new text
+        Gtk::TextBuffer::iterator begin = end;
+        begin.backward_chars(record.get_text().length() );
+        update_user_colour(begin, end, *user);
+
+        m_view.queue_draw();
         m_editing = false;
 }
@@ -210 +319 @@
 }
 
-void Gobby::Document::on_insert_after(const Gtk::TextBuffer::iterator& begin,
+void Gobby::Document::on_insert_after(const Gtk::TextBuffer::iterator& end,
                                       const Glib::ustring& text,
                                       int bytes)
 {
+        // Other editing function is at work.
+        if(!m_editing)
+        {
+                // TODO: Find a better solution to access the local user object.
+                obby::client_document* client_doc =
+                        dynamic_cast<obby::client_document*>(&m_doc);
+                obby::host_document* host_doc =
+                        dynamic_cast<obby::host_document*>(&m_doc);
+
+                const obby::user* user = NULL;
+                if(client_doc != NULL)
+                        user = &client_doc->get_buffer().get_self();
+                if(host_doc != NULL)
+                        user = &host_doc->get_buffer().get_self();
+
+                assert(user != NULL);
+
+                // Find start position of new text
+                Gtk::TextBuffer::iterator pos = end;
+                pos.backward_chars(text.length() );
+
+                // Update colour
+                update_user_colour(pos, end, *user);
+        }
+
         // Document changed: Update statusbar
         m_signal_update.emit();
@@ -235 +369 @@
 }
 
+void Gobby::Document::update_user_colour(const Gtk::TextBuffer::iterator& begin,
+                                         const Gtk::TextBuffer::iterator& end,
+                                         const obby::user& user)
+{
+        // Remove other user tags in that range
+        Glib::RefPtr<Gtk::TextBuffer> buffer = m_view.get_buffer();
+        Glib::RefPtr<Gtk::TextBuffer::TagTable> tag_table =
+                buffer->get_tag_table();
+
+        tag_table->foreach(
+                sigc::bind(
+                        sigc::mem_fun(
+                                *this,
+                                &Document::on_remove_user_colour
+                        ),
+                        sigc::ref(begin),
+                        sigc::ref(end)
+                )
+        );
+
+        // Insert new user tag to the given range
+        buffer->apply_tag_by_name("gobby_user_" + user.get_name(), begin, end);
+}
+
+void
+Gobby::Document::on_remove_user_colour(Glib::RefPtr<Gtk::TextBuffer::Tag> tag,
+                                       const Gtk::TextBuffer::iterator& begin,
+                                       const Gtk::TextBuffer::iterator& end)
+{
+        // Remove tag if it is a user color tag.
+        Glib::ustring tag_name = tag->property_name();
+        if(tag_name.compare(0, 10, "gobby_user") == 0)
+                m_view.get_buffer()->remove_tag(tag, begin, end);
+}
+

src/folder.cpp

@@ -69 +69 @@
 void Gobby::Folder::obby_user_join(obby::user& user)
 {
+        // Pass user join event to documents
+        for(unsigned int i = 0; i < get_n_pages(); ++ i)
+                static_cast<Document*>(get_nth_page(i) )->obby_user_join(user);
 }
 
 void Gobby::Folder::obby_user_part(obby::user& user)
 {
+        // Pass user part event to documents
+        for(unsigned int i = 0; i < get_n_pages(); ++ i)
+                static_cast<Document*>(get_nth_page(i) )->obby_user_part(user);
 }
 
 void Gobby::Folder::obby_document_insert(obby::document& document)
 {
+        // Create new document
         Document* new_doc = new Document(document, *this);
+
+        // Watch update signal to emit document_updated signal if a document
+        // has been updated.
         new_doc->update_event().connect(
                 sigc::bind(
@@ -85 +95 @@
         );
 
+        // Append document's title as new page to the notebook
         append_page(*new_doc, document.get_title());
+
+        // Show child
         new_doc->show_all();
 }
@@ -91 +104 @@
 void Gobby::Folder::obby_document_remove(obby::document& document)
 {
+        // Find corresponding Document widget in notebook
         for(int i = 0; i < get_n_pages(); ++ i)
         {
@@ -96 +110 @@
                 if(&static_cast<Document*>(doc)->get_document() == &document)
                 {
+                        // Delete it.
                         remove_page(i);
                         delete doc;
@@ -111 +126 @@
 void Gobby::Folder::on_switch_page(GtkNotebookPage* page, guint page_num)
 {
+        // Another document has been selected: Update statusbar
         m_signal_document_update.emit(
                 *static_cast<Document*>(get_nth_page(page_num))
         );
+
         Gtk::Notebook::on_switch_page(page, page_num);
 }
@@ -119 +136 @@
 void Gobby::Folder::on_document_update(Document& document)
 {
+        // Update in the currently visible document? Update statusbar.
         if(get_current_page() == page_num(document) )
                 m_signal_document_update.emit(document);