---

WWhizInterface2.h

Go to the documentation of this file.

// $Workfile: WWhizInterface2.h $
// $Archive: /WorkspaceWhiz/Src/Shared/WWhizInterface2.h $
// $Date:: 1/03/01 12:13a  $ $Revision:: 34   $ $Author: Jjensen $
// This source file is part of the Workspace Whiz! source distribution and
// is Copyright 1997-2001 by Joshua C. Jensen.  (http://workspacewhiz.com/)
//
// The code presented in this file may be freely used and modified for all
// non-commercial and commercial purposes so long as due credit is given and
// this header is left intact.
#pragma once

struct WWhizReg;
class WWhizProjectList;
class WWhizProject;
class WWhizFileList;
class WWhizFile;
class WWhizTagList;
class WWhizTag;
class WWhizConfig;
class XmlData;

class WWhizBase
{
public:
    virtual UINT GetRefCount() = 0;

    virtual UINT AddRef() = 0;

    virtual UINT Release() = 0;
};


class WWhizTag //: public WWhizBase
{
public:
    enum Access
    {
        PUBLIC,         
        PROTECTED,      
        PRIVATE,        
        FRIEND,
    };

    enum ImplementationType
    {
        DEFAULT,
        ABSTRACT,
        VIRTUAL,
        PUREVIRTUAL,
    };

    enum Type
    {
        CLASS,          
        DECLARATION,    
        DEFINE,         
        ENUM,           
        ENUMMEMBER,     
        FILE,           
        FUNCTION,       
        MEMBER,         
        NAMESPACE,      
        STRUCTURE,      
        TYPEDEF,        
        UNION,          
        VARIABLE,       
        LAST_TYPE,
    };

    virtual Type GetType(void) const = 0;

    virtual LPCSTR GetShortIdent(void) const = 0;

    virtual LPCSTR GetIdent(void) const = 0;

    virtual LPCSTR GetFilename(void) const = 0;

    virtual LPCSTR GetSearchString(void) const = 0;

    virtual LPCSTR GetShortParentIdent(void) const = 0;

    virtual LPCSTR GetParentIdent(void) const = 0;

    virtual int GetLineNumber(void) const = 0;

    virtual WWhizTag* GetMatchNext(void) const = 0;

    virtual WWhizTag* GetMatchPrev(void) const = 0;

    virtual Access GetAccess(void) const = 0;

    virtual LPCSTR GetNamespace(void) const = 0;

    virtual WWhizTag* GetBuddy(void) const = 0;

    virtual ImplementationType GetImplementationType(void) const = 0;
};


class WWhizInterface
{
public:
    struct TagCallbackInfo
    {
        void* m_userData;           
        int m_curFile;              
        int m_numFiles;             
        LPCTSTR m_curFilename;      

        enum Type
        {
            REFRESH,
            LOAD,
            SAVE,
        };

        Type m_type;
    };

    typedef void (*TagRefreshCallback)(const TagCallbackInfo& info);

    virtual void Reserved0() = 0;

    // File support

    virtual WWhizProjectList& GetProjectList(void) const = 0;

    virtual WWhizFileList& GetFileList(void) const = 0;

    virtual CString GetWorkspaceName(void) const = 0;

    virtual const CString& GetWorkspaceLocation(void) const = 0;

    virtual void SetWorkspaceLocation(void) = 0;

    virtual const CString& GetExtraFilename(void) = 0;

    virtual bool GetCurrentFilename(CString& filename) const = 0;

    virtual WWhizProject* GetCurrentProject() const = 0;

    virtual void ResolveFilename(const CString& rootDir, CString& filename) = 0;

    virtual bool RefreshFileList(void) = 0;

    virtual void AddProject(CString projectName) = 0;

    virtual void RemoveAllFiles(void) = 0;

    virtual void Reserved1() = 0;

    // Tag support

    virtual const WWhizTag* GetTagMatchHead(void) const = 0;

    virtual const WWhizTag* GetTagMatchTail(void) const = 0;

    virtual int GetTagMatchCount(void) const = 0;

    virtual const WWhizTag* GetLastMatchedTag(void) const = 0;

    virtual const WWhizTagList& GetTagList(void) const = 0;

    virtual void RemoveAllTags(void) = 0;

    virtual void MatchTag(const WWhizTagList& tags, LPCTSTR name, WWhizTag::Type forceType = WWhizTag::LAST_TYPE) const = 0;

    virtual bool GotoTag(const WWhizTag* tag) const = 0;

    virtual void SetTagCallback(TagRefreshCallback callback, void* userData) = 0;

    virtual void RefreshTagList(bool forceRefresh = false, bool forceSave = false) = 0;

    virtual void LoadTags() = 0;

    virtual void SaveTags() = 0;

    virtual bool GetTagUseType(WWhizTag::Type type) = 0;

    virtual void SetTagUseType(WWhizTag::Type type, bool use) = 0;

    // Global files
    virtual WWhizFileList& GetGlobalFileList(void) const = 0;

    virtual bool RefreshGlobalFileList(void) = 0;
    
    // Misc
    virtual WWhizConfig& GetConfig() = 0;

    // More stuff appended to the end.
    virtual CTime GetLastFileRefreshTime() const = 0;

    virtual CTime GetLastTagRefreshTime() const = 0;

    virtual void SetWWhizReg(WWhizReg* wwhizReg) = 0;

    virtual WWhizFileList& GetActiveFileList(void) const = 0;

    virtual DWORD GetVersion(void) const = 0;

    virtual void AddChangedFile(CString filename) = 0;

    virtual void CheckActiveFilesForChanges() = 0;

    virtual const WWhizTag* GetTagScope(const CString& filename, UINT lineNumber) = 0;

    virtual const CString& GetWorkspaceFullPath(void) const = 0;
};


class WWhizConfig
{
public:
    // Files extension list.

    virtual void FilesExtReset() = 0;

    virtual void FilesExtRemoveAll() = 0;

    virtual void FilesExtAdd(CString ext) = 0;

    virtual void FilesExtRemove(int index) = 0;

    virtual const CString& FilesExtGet(int index) = 0;

    virtual int FilesExtGetCount() = 0;

    // Tags extension list.

    virtual void TagsExtReset() = 0;

    virtual void TagsExtRemoveAll() = 0;

    virtual void TagsExtAdd(CString ext) = 0;

    virtual void TagsExtRemove(int index) = 0;

    virtual int TagsExtGetCount() = 0;

    virtual const CString& TagsExtGet(int index) = 0;

    // Misc.

    virtual UINT GetTagAutoPackAmount() = 0;

    virtual void SetTagAutoPackAmount(UINT amount) = 0;

    virtual bool GetAutoRefreshTags() = 0;

    virtual void SetAutoRefreshTags(bool autoRefresh) = 0;

    virtual bool GetScanFilesTaskSwitch() = 0;

    virtual void SetScanFilesTaskSwitch(bool scanFiles) = 0;
    
    // Tokens to ignore.

    virtual void IgnoreTokensReset() = 0;

    virtual void IgnoreTokensRemoveAll() = 0;

    virtual void IgnoreTokensAdd(CString ext) = 0;

    virtual void IgnoreTokensRemove(int index) = 0;

    virtual int IgnoreTokensGetCount() = 0;

    virtual const CString& IgnoreTokensGet(int index) = 0;

    // Misc.

    virtual UINT GetTagAutoSaveAmount() = 0;

    virtual void SetTagAutoSaveAmount(UINT amount) = 0;
};


class WWhizProjectList
{
public:
    virtual int GetProjectCount() const = 0;

    virtual WWhizProject* GetProjectByIndex(int index) const = 0;

    virtual WWhizProject* Find(CString projectName) const = 0;
};


class WWhizProject
{
public:
    virtual const CString& GetName(void) const = 0;

    virtual bool IsActive(void) const = 0;

    virtual const CTime& GetTimeStamp(void) const = 0;

    virtual WWhizFileList& GetFileList(void) const = 0;

    virtual WWhizTagList& GetTagList(void) const = 0;

    virtual bool IsWorkspaceProject(void) const = 0;

    virtual void SetActive(bool active = true) = 0;

    virtual XmlData& GetXmlData() = 0;
};


class WWhizFileList
{
public:
    virtual int GetCount(void) const = 0;

    virtual WWhizFile* Get(int index) const = 0;

    virtual WWhizFile* Find(CString fullName) const = 0;

    virtual int FindExact(WWhizFile& file) const = 0;

    virtual int FindNext(int startPos, WWhizFile& file) const = 0;

    virtual int FindPrevious(int startPos, WWhizFile& file) const = 0;

    virtual WWhizFile& Create(const CString& filename) = 0;
};


class WWhizFile : public WWhizBase
{
public:
    virtual const CString& GetFullName() const = 0;

    virtual CString GetCaseFullName() const = 0;

    virtual const CString& GetShortName(void) const = 0;

    virtual const CString& GetTitle(void) const = 0;

    virtual const CString& GetExt(void) const = 0;

    virtual const CString& GetPath(void) const = 0;

    virtual const CTime& GetTimeStamp(void) const = 0;

    virtual WWhizTagList& GetTagList(void) const = 0;


    virtual void SetShortName(const CString& shortName) = 0;

    virtual void SetTitle(const CString& title) = 0;

    virtual void SetExt(const CString& ext) = 0;

    virtual void SetPath(const CString& path) = 0;

    virtual void SetTimeStamp(CTime timeStamp) = 0;

    virtual WWhizTagList& GetOrderedTagList(void) const = 0;

    virtual bool IsWorkspaceFile(void) const = 0;
};


class WWhizTagList
{
public:
    virtual int GetCount(void) const = 0;

    virtual WWhizTag* Get(int index) const = 0;
};

---