viewscript.h

Go to the documentation of this file.

/**
 * \file gre/viewscript.h
 * \brief GRE::VIEWSCRIPT and related class definitions
 *
 * \if NODOC
 * $Id: viewscript.h_v 1.10 2005/03/31 16:57:07 fileserver!dwilliss Exp $
 *
 * $Log: viewscript.h_v $
 * Revision 1.10  2005/03/31 16:57:07  fileserver!dwilliss
 * Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
 *
 * Revision 1.9  2003/11/10 18:44:03  mju
 * Obtain filepath from viewable after edit script if is from viewable.
 *
 * Revision 1.8  2003/10/02 16:18:21  linux32build!build
 * Doxygen
 *
 * Revision 1.7  2003/09/23 13:05:34  mju
 * Fix compiler warnings.
 *
 * Revision 1.6  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.5  2003/09/09 16:22:24  mju
 * Add SetFilePath method.
 *
 * Revision 1.4  2003/07/30 15:50:04  mju
 * Ignore forward decls.
 *
 * Revision 1.3  2003/06/30 20:08:39  mju
 * Now keeps script with macroscript context.
 *
 * Revision 1.2  2003/06/24 16:25:24  mju
 * Support saving scripts with viewable.
 *
 * Revision 1.1  2003/06/16 19:40:49  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_GRE_VIEWSCRIPT_H
#define  INC_GRE_VIEWSCRIPT_H

#ifndef  INC_GRE_BASE_H
   #include <gre/base.h>
#endif

#ifndef  INC_MI32_FILEPATH_H
   #include <mi32/filepath.h>
#endif

#ifndef  INC_MI32_FIXEDSTR_H
   #include <mi32/fixedstr.h>
#endif

#ifndef  INC_MI32_MICON_H
   #include <mi32/micon.h>
#endif

#ifndef  INC_MI32_SERIALIZ_H
   #include <mi32/serializ.h>
#endif

#ifndef  INC_MI32_SIMPLEAR_H
   #include <mi32/simplear.h>
#endif

#if !defined(INC_MI32_XDEFNS_H) && defined(X_NATIVE)
   #include <mi32/xdefns.h>
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
struct SMLCONTEXT;
class SMLSYMBOL;
#endif // GENERATING_DOXYGEN_OUTPUT

#ifdef X_NATIVE
namespace GRE {

//===================================================================================================================

class VIEWSCRIPT : public SERIALIZABLE {
   public:

      class CONTEXT;

      //! Default Constructor.
      VIEWSCRIPT ();

      //! Copy constructor.
      VIEWSCRIPT (
         const VIEWSCRIPT& rhs
         ): SERIALIZABLE(rhs) { Copy(rhs); }

      //! Destructor.
      virtual ~VIEWSCRIPT ();

      //! Assignment operator.
      VIEWSCRIPT& operator= (
         const VIEWSCRIPT& rhs
         ) { if (this != &rhs) { MiconDestroy(m_icon); Copy(rhs); } return (*this); }

      virtual void IniWrite (
         const char* IniGroup,
         const char* IniBaseName
         ) const;

      virtual int Load (
         const char* IniGroup = 0,
         const char* IniBaseName = 0
         );

      bool EditProperties (
         MDLGPARENT dlgparent,
         GRE_VIEWABLE *viewable,
         GRE_VIEW *view,
         bool CanChangeSet
         );

      //! @return TRUE if changed, FALSE if not, < 0 if error
      int EditScript (
         Widget pwidget,
         SMLCONTEXT* smlcontext
         );

      const FILEPATH& GetFilePath (
         ) const { return (m_filepath); }

      const MICON GetIcon (
         ) const {
         if (m_icon == 0) {
            MiconCreate(&m_icon,m_IconGroup,m_IconName,0,16,16,MICONFLAG_DefaultBackground);
            }
         return (m_icon);
         }

      const char* GetIconGroup (
         ) const { return (m_IconGroup); }

      const char* GetIconName (
         ) const { return (m_IconName); }

      const MIUNICODE* GetName (
         ) const { return (m_name); }

      const MISTRING& GetScriptString (
         ) const { return (m_scriptstr); }

      bool GetShowIcon (
         ) const { return (m_ShowIcon); }

      bool IsFromViewable (
         ) const { return (m_FromViewable); }

      ERRVALUE Load (
         const FILEPATH& filepath
         ) { m_filepath = filepath; return (Load()); }

      bool SelectIcon (
         MDLGPARENT dlgparent
         );

      void SetFilePath (
         const FILEPATH& filepath
         ) { m_filepath = filepath; }

      void SetFromViewable (
         bool FromViewable = true
         ) { m_FromViewable = FromViewable; }

      void SetName (
         const MIUNICODE *name
         ) { m_name = name; }

      void SetShowIcon (
         bool ShowIcon
         ) { m_ShowIcon = ShowIcon; }

   protected:

      //! Get serialization item definition table.
      static const SERIALIZER::ITEMDEF* SerialGetItemDef (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      FILEPATH m_filepath;
      INT32 m_inode;
      MISTRING m_scriptstr;
      FIXEDSTRING<64> m_name;
      char m_IconGroup[16];
      char m_IconName[16];
      mutable MICON m_icon;
      bool m_ShowIcon;
      bool m_FromViewable;

      void Copy (const VIEWSCRIPT& rhs);

      virtual bool v_EditProperties (
         MDLGPARENT dlgparent,
         GRE_VIEWABLE *viewable,
         GRE_VIEW *view,
         bool CanChangeSet
         ) = 0;

      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//===================================================================================================================

class VIEWSCRIPT::CONTEXT {
   public:

      SMLCONTEXT* GetSMLContext (
         ) const { return (m_smlcontext); }

      ERRVALUE ParseScript (
         const VIEWSCRIPT& script
         );

   protected:

      CONTEXT (
         GRE_VIEWABLE *viewable,
         GRE_VIEW *view
         );

      ~CONTEXT ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      SMLCONTEXT *m_smlcontext;

      CONTEXT (const CONTEXT&);
      CONTEXT& operator= (const CONTEXT&);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//===================================================================================================================

class MACROSCRIPT : public VIEWSCRIPT {
   public:

      enum BUTTONTYPE {
         BUTTONTYPE_Simple =  0,
         BUTTONTYPE_Menu =    1
         };

      class CONTEXT;

      //! Default constructor.
      MACROSCRIPT (
         ): m_ButtonType(BUTTONTYPE_Simple) { }

      //! Copy constructor.
      MACROSCRIPT (
         const MACROSCRIPT& rhs
         );

      //! Destructor.
      virtual ~MACROSCRIPT (
         );

      //! Assignment.
      MACROSCRIPT& operator= (
         const MACROSCRIPT& rhs
         );

      BUTTONTYPE GetButtonType (
         ) const { return (static_cast<BUTTONTYPE>(m_ButtonType)); }

      const MISTRINGLIST& GetMenuChoiceList (
         ) const { return (m_MenuChoiceList); }

      virtual void IniWrite (
         const char* IniGroup,
         const char* IniBaseName
         ) const;

      virtual int Load (
         const char* IniGroup = 0,
         const char* IniBaseName = 0
         );

      virtual ERRVALUE SerialRead (
         SERIALIZER& serializer
         );

      virtual ERRVALUE SerialWrite (
         SERIALIZER& serializer,
         const char *tagname = 0
         ) const;

      void SetButtonType (
         BUTTONTYPE ButtonType
         ) { m_ButtonType = static_cast<UINT8>(ButtonType); }

      void SetMenuChoices (
         const MISTRING& string
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      UINT8 m_ButtonType;
      MISTRINGLIST m_MenuChoiceList;

      static ERRVALUE SerialCB_MenuChoice (SERIALIZER&, const SERIALIZER::ITEMDEF*, MACROSCRIPT *script, SERIALIZER::ITEMDEF::ACTION);
      static const SERIALIZER::ITEMDEF* SerialGetItemDef ();

      virtual bool v_EditProperties (
         MDLGPARENT dlgparent,
         GRE_VIEWABLE *viewable,
         GRE_VIEW *view,
         bool CanChangeSet
         );

      #endif // GENERATING_DOXYGEN_OUTPUT
   };
typedef MILIST<MACROSCRIPT> MACROSCRIPTLIST;

//! Dialog to edit list of MacroScripts for specified viewable and optional view.
//! @return true if changed, false if not.
bool DlgEditMacroScriptList (
   MDLGPARENT dlgparent,
   MACROSCRIPTLIST& ScriptList,
   GRE_VIEWABLE *viewable,
   GRE_VIEW *view = 0
   );


//===================================================================================================================

class MACROSCRIPT::CONTEXT : public VIEWSCRIPT::CONTEXT {
   public:

      //! Constructor.
      CONTEXT (
         GRE_VIEWABLE *viewable,
         GRE_VIEW *view,
         bool AddAllSymbols = false
         );

      //! Destructor.
      virtual ~CONTEXT ();

      bool AddCtrlToMenu (
         Widget MenuPane
         );

      bool AddCtrlToToolBar (
         Widget ToolBar
         );

      ERRVALUE Create (
         const MACROSCRIPT& script
         );

      const MISTRINGLIST& GetMenuChoiceList (
         ) const { return (m_script.GetMenuChoiceList()); }

      ERRVALUE Run (
         );

      ERRVALUE Run (
         const MIUNICODE* menuchoice
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      MACROSCRIPT m_script;
      SMLSYMBOL *m_MenuChoiceSym;

      void GetMenuItems (SIMPLE_ARRAY<MENUITEM>& MenuItems) const;

      CONTEXT (const CONTEXT&);
      CONTEXT& operator= (const CONTEXT&);
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//===================================================================================================================

class TOOLSCRIPT : public VIEWSCRIPT {
   public:

      TOOLSCRIPT () { }

      TOOLSCRIPT (
         const TOOLSCRIPT& rhs
         ): VIEWSCRIPT(rhs) { }

      virtual ~TOOLSCRIPT (
         ) { }

      TOOLSCRIPT& operator= (
         const TOOLSCRIPT& rhs
         ) {
         if (this != &rhs) {
            static_cast<VIEWSCRIPT*>(this)->operator=(rhs);
            }
         return (*this);
         }

      virtual ERRVALUE SerialRead (
         SERIALIZER& serializer
         );

      virtual ERRVALUE SerialWrite (
         SERIALIZER& serializer,
         const char *tagname = 0
         ) const;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      virtual bool v_EditProperties (
         MDLGPARENT dlgparent,
         GRE_VIEWABLE *viewable,
         GRE_VIEW *view,
         bool CanChangeSet
         );

      #endif // GENERATING_DOXYGEN_OUTPUT
   };
typedef MILIST<TOOLSCRIPT> TOOLSCRIPTLIST;

//! Dialog to edit list of ToolScripts for specified viewable and optional view.
//! @return true if changed, false if not.
bool DlgEditToolScriptList (
   MDLGPARENT dlgparent,
   TOOLSCRIPTLIST& ScriptList,
   GRE_VIEWABLE *viewable,
   GRE_VIEW *view = 0
   );


}  // End namespace GRE
#endif

//===================================================================================================================

#endif   // INC_GRE_VIEWSCRIPT_H

---