Reference Manual

sourcetag.h

Go to the documentation of this file.

/*  Inti-SourceView: Integrated Foundation Classes
 *  Copyright (C) 2003 The Inti Development Team.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */


#ifndef INTI_GTK_SOURCE_TAG_H
#define INTI_GTK_SOURCE_TAG_H

#ifndef INTI_GTK_TEXT_TAG_H
#include <inti/gtk/texttag.h>
#endif

#ifndef __GTK_SOURCE_TAG_H__
#include <gtksourceview/gtksourcetag.h>
#endif

#ifndef __GTK_SOURCE_TAG_TABLE_H__
#include <gtksourceview/gtksourcetagtable.h>
#endif

namespace Inti {

namespace Gtk {

class SourceTagStyle;
class SourceTagTableClass;


class SourceTag : public TextTag
{
        friend class G::Object;

        SourceTag(const SourceTag&);
        SourceTag& operator=(const SourceTag&);

protected:

        explicit SourceTag(GtkSourceTag *tag, bool reference = false);

//  Properties

        typedef G::Property<String> IdPropertyType;
        typedef G::PropertyProxy<G::Object, IdPropertyType> IdPropertyProxy;
        static const IdPropertyType id_property;

        typedef G::Property<Pointer<SourceTagStyle> > TagStylePropertyType;
        typedef G::PropertyProxy<G::Object, TagStylePropertyType> TagStylePropertyProxy;
        static const TagStylePropertyType tag_style_property;

public:

        virtual ~SourceTag();


        GtkSourceTag* gtk_source_tag() const { return (GtkSourceTag*)instance; }

        operator GtkSourceTag* () const;

        bool is_gtk_source_tag() const;

        String get_id() const;

        SourceTagStyle* get_style() const;


        void set_style(const SourceTagStyle& style);


        const IdPropertyProxy prop_id()
        {
                return IdPropertyProxy(this, &id_property);
        }

        const TagStylePropertyProxy prop_tag_style()
        {
                return TagStylePropertyProxy(this, &tag_style_property);
        }

};


class SyntaxTag : public SourceTag
{
        friend class G::Object;

        SyntaxTag(const SyntaxTag&);
        SyntaxTag& operator=(const SyntaxTag&);

protected:

        explicit SyntaxTag(GtkSyntaxTag *tag, bool reference = false);


public:

        SyntaxTag(const String& id, const String& name, const char *pattern_start, const char *pattern_end);

        virtual ~SyntaxTag();


        GtkSyntaxTag* gtk_syntax_tag() const { return (GtkSyntaxTag*)instance; }

        operator GtkSyntaxTag* () const;

        bool is_gtk_syntax_tag() const;

};


class LineCommentTag : public SyntaxTag
{
public:

        LineCommentTag(const String& id, const String& name, const char *pattern_start);

};


class StringTag : public SyntaxTag
{
public:

        StringTag(const String& id, const String& name, const char *pattern_start, const char *pattern_end, bool end_at_line_end);

};


class PatternTag : public SourceTag
{
        friend class G::Object;

        PatternTag(const PatternTag&);
        PatternTag& operator=(const PatternTag&);

protected:

        explicit PatternTag(GtkPatternTag *tag, bool reference = false);


public:

        PatternTag(const String& id, const String& name, const char *pattern);

        virtual ~PatternTag();


        GtkPatternTag* gtk_pattern_tag() const { return (GtkPatternTag*)instance; }

        operator GtkPatternTag* () const;

        bool is_gtk_pattern_tag() const;

};


class KeywordListTag : public PatternTag
{
public:

        KeywordListTag(const String& id, const String& name, std::vector<String>& keywords, bool case_sensitive,
                       bool match_empty_string_at_beginning, bool match_empty_string_at_end,
                       const char *beginning_regex, const char *end_regex);

};


class SourceTagTable : public TextTagTable
{
        friend class G::Object;
        friend class SourceTagTableClass;

        SourceTagTable(const SourceTagTable&);
        SourceTagTable& operator=(const SourceTagTable&);

protected:

        explicit SourceTagTable(GtkSourceTagTable *table, bool reference = false);


        virtual void on_changed();

//  Signals

        typedef G::Signal0<void> ChangedSignalType;
        typedef G::SignalProxy<TypeInstance, ChangedSignalType> ChangedSignalProxy;
        static const ChangedSignalType changed_signal;

public:

        SourceTagTable();

        virtual ~SourceTagTable();


        GtkSourceTagTable* gtk_source_tag_table() const { return (GtkSourceTagTable*)instance; }

        GtkSourceTagTableClass* gtk_source_tag_table_class() const;

        operator GtkSourceTagTable* () const;

        bool is_gtk_source_tag_table() const;


        void add_tags(const std::vector<TextTag*>& tags);

        void remove_source_tags();


        const ChangedSignalProxy sig_changed()
        {
                return ChangedSignalProxy(this, &changed_signal);
        }

};

} // namespace Gtk

} // namespace Inti

#endif // INTI_GTK_SOURCE_TAG_H