GDocView.h

Go to the documentation of this file.

#ifndef __GDOCVIEW_H
#define __GDOCVIEW_H

#include "GVariant.h"

// Word wrap

#define TEXTED_WRAP_NONE            0
#define TEXTED_WRAP_REFLOW          1

// Notify flags

#define GTVN_DOC_CHANGED            0x01
#define GTVN_CURSOR_CHANGED         0x02
#define GTVN_CODEPAGE_CHANGED       0x04
#define GTVN_FIXED_WIDTH_CHANGED    0x08
#define GTVN_SHOW_IMGS_CHANGED      0x10

// Util macros

#define IsAlpha(c)                  (((c) >= 'a' AND (c) <= 'z') OR ((c) >= 'A' AND (c) <= 'Z'))
#define IsWhiteSpace(c)             ((c) < 126 AND strchr(GDocView::WhiteSpace, c) != 0)
#define IsDelimiter(c)              ((c) < 126 AND strchr(GDocView::Delimiters, c) != 0)
#define IsDigit(c)                  ((c) >= '0' AND (c) <= '9')
#define IsLetter(c)                 (((c) >= 'a' AND (c) <= 'z') OR ((c) >= 'A' AND (c) <= 'Z'))
#define IsText(c)                   (IsDigit(c) OR IsAlpha(c) OR (c) == '_')
#define IsWordBoundry(c)            (strchr(GDocView::WhiteSpace, c) OR strchr(GDocView::Delimiters, c))
#define UrlChar(c)                  ( \
                                        strchr(GDocView::UrlDelim, (c)) OR \
                                        AlphaOrDigit((c)) OR \
                                        ((c) >= 256) \
                                    )
#define EmailChar(c)                (strchr("._-:+", (c)) OR AlphaOrDigit((c)))

extern char16 *ConvertToCrLf(char16 *Text);

// Call back class to handle viewer events
class GDocView;

class GDocumentEnv : public GThreadOwner
{
    GArray<GDocView*> Viewers;

public:
    GDocumentEnv(GDocView *v = 0);
    virtual ~GDocumentEnv();

    enum LoadType
    {
        LoadError,
        LoadNotImpl,
        LoadImmediate,
        LoadDeferred,
    };

    struct LoadJob : public GThreadJob
    {
        enum PrefFormat
        {
            FmtNone,
            FmtStream,
            FmtSurface,
            FmtFilename,
        };
        
        // View data
        GDocView *View;
        void *UserData;
        uint32 UserUid;
        PrefFormat Pref;

        // Input data
        GAutoString Uri;

        // Output data
        GAutoPtr<GStreamI> Stream;
        GAutoPtr<GSurface> pDC;
        GAutoString Filename;
        GAutoString Error;

        LoadJob(GThreadTarget *o) : GThreadJob(o)
        {
            View = 0;
            UserUid = 0;
            UserData = 0;
            Pref = FmtNone;
        }
    };

    LoadJob *NewJob()
    {
        return new LoadJob(this);
    }

    bool AttachView(GDocView *v)
    {
        if (!v)
            return false;
        if (!Lock(_FL))
            return false;
        LgiAssert(!Viewers.HasItem(v));
        Viewers.Add(v);
        Unlock();
        return true;
    }

    bool DetachView(GDocView *v)
    {
        if (!v)
            return false;
        if (!Lock(_FL))
            return false;
        LgiAssert(Viewers.HasItem(v));
        Viewers.Delete(v);
        Unlock();
        return true;
    }
    
    virtual bool AppendItems(GSubMenu *Menu, int Base = 1000) { return false; }
    
    virtual bool OnMenu(GDocView *View, int Id, void *Context) { return false; }
    
    virtual LoadType GetContent(LoadJob *&j) { return LoadNotImpl; }
    void OnDone(GThreadJob *j);
    
    virtual bool OnNavigate(char *Uri) { return false; }

    virtual char *OnDynamicContent(char *Code) { return 0; }

    virtual bool OnCompileScript(char *Script, char *Language, char *MimeType) { return false; }

    virtual bool OnExecuteScript(char *Script) { return false; }
};

class GDefaultDocumentEnv : public GDocumentEnv
{
public:
    LoadType GetContent(LoadJob *&j);
    bool OnNavigate(char *Uri);
};

class GDocFindReplaceParams {};

class
#ifdef MAC
LgiClass
#endif
GDocView : public GLayout
{
    friend class GDocumentEnv;

protected:
    GDocumentEnv *Environment;
    char *Charset;

public:
    // Static
    static char *WhiteSpace;
    static char *Delimiters;
    static char *UrlDelim;
    static bool AlphaOrDigit(char c);

    // Properties
    #define _TvMenuProp(Type, Name)                     \
    protected:                                          \
        Type Name;                                      \
    public:                                             \
        virtual void Set##Name(Type i) { Name=i; }      \
        Type Get##Name() { return Name; }

    _TvMenuProp(uint16, WrapAtCol)
    _TvMenuProp(bool, UrlDetect)
    _TvMenuProp(bool, ReadOnly)
    _TvMenuProp(uint8, WrapType)
    _TvMenuProp(uint8, TabSize)
    _TvMenuProp(uint8, IndentSize)
    _TvMenuProp(bool, HardTabs)
    _TvMenuProp(bool, ShowWhiteSpace)
    _TvMenuProp(bool, ObscurePassword)
    _TvMenuProp(bool, CrLf)
    _TvMenuProp(bool, AutoIndent)
    _TvMenuProp(bool, FixedWidthFont)
    _TvMenuProp(COLOUR, BackColour)
    _TvMenuProp(bool, LoadImages)
    _TvMenuProp(bool, OverideDocCharset)
    #undef _TvMenuProp

    char *GetCharset() { return Charset; }
    void SetCharset(char *s) { char *cs = NewStr(s); DeleteArray(Charset); Charset = cs; }
    virtual char *GetMimeType() = 0;

    // Object
    GDocView(GDocumentEnv *e = 0)
    {
        WrapAtCol = 0;
        UrlDetect = true;
        ReadOnly = false;
        WrapType = TEXTED_WRAP_REFLOW;
        TabSize = 4;
        IndentSize = 4;
        HardTabs = true;
        ShowWhiteSpace = false;
        ObscurePassword = false;
        CrLf = false;
        AutoIndent = true;
        FixedWidthFont = false;
        BackColour = Rgb24(255, 255, 255);
        LoadImages = false;
        Charset = 0;
        OverideDocCharset = false;

        Environment = 0;

        SetEnv(e);
    }

    virtual ~GDocView()
    {
        SetEnv(0);
    }

    char *GetClass() { return "GDocView"; }

    virtual bool Open(char *Name, char *Cs = 0) { return false; }
    virtual bool Save(char *Name, char *Cs = 0) { return false; }


    virtual bool DoFind() { return false; }
    virtual bool DoReplace() { return false; }
    virtual GDocFindReplaceParams *CreateFindReplaceParams() { return 0; }
    virtual void SetFindReplaceParams(GDocFindReplaceParams *Params) { }


    virtual GDocumentEnv *GetEnv() { return Environment; }
    virtual void SetEnv(GDocumentEnv *e)
    {
        if (Environment) Environment->DetachView(this);
        Environment = e;
        if (Environment) Environment->AttachView(this);
    }
    virtual void OnContent(GDocumentEnv::LoadJob *Res) {}
    
    // State / Selection
    
    virtual void SetCursor(int i, bool Select, bool ForceFullUpdate = false) {}

    virtual int GetCursor(bool Cursor = true) { return 0; }

    virtual bool HasSelection() { return false; }
    virtual void UnSelectAll() {}
    virtual void SelectWord(int From) {}
    virtual void SelectAll() {}
    virtual char *GetSelection() { return 0; }

    virtual int IndexAt(int x, int y) { return 0; }

    virtual void PositionAt(int &x, int &y, int Index = -1) { }

    virtual bool IsDirty() { return false; }
    virtual int GetLines() { return 0; }
    virtual void GetTextExtent(int &x, int &y) {}

    
    virtual bool Cut() { return false; }
    virtual bool Copy() { return false; }
    virtual bool Paste() { return false; }


    virtual void OnEscape(GKey &K) {}
    virtual void OnEnter(GKey &k) {}
    virtual void OnUrl(char *Url) {}


    struct ContentMedia
    {
        GAutoString Id;
        GVariant Data;
        GAutoPtr<GStream> Stream;
    };

    virtual bool GetFormattedContent
    (
        char *MimeType,
        GAutoString &Out,
        GArray<ContentMedia> *Media = 0
    )
    { return false; }
};

#endif

---