Y2UINamespace.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                        (C) SuSE GmbH |
\----------------------------------------------------------------------/

   File:        Y2UINamespace.h

   Authors:     Stanislav Visnovsky <visnov@suse.cz>

   Maintainer:  Stefan Hundhammer <sh@suse.de>

/-*/


#include <y2/Y2Namespace.h>
#include <y2/Y2Function.h>
#include "ycp/YCPBoolean.h"
#include "ycp/YCPInteger.h"
#include "ycp/YCPVoid.h"
#include "ycp/YCPString.h"
#include "ycp/YCPCode.h"
#include "ycp/StaticDeclaration.h"

#define y2log_component "ui"
#include "ycp/y2log.h"

#include "YUI.h"
#include "YUIComponent.h"

class Y2UINamespace;

class Y2UIFunction: public Y2Function
{
    protected:

    unsigned int m_position;
    Y2UINamespace* m_instance;
    YUIComponent* m_comp;
    bool m_play_macro_blocks;
    YCPValue m_param1;
    YCPValue m_param2;
    YCPValue m_param3;
    YCPValue m_param4;
    YCPValue m_param5;
    public:

    Y2UIFunction (Y2UINamespace* instance, YUIComponent* comp, unsigned int pos, bool play_macro_blocks);

    bool attachParameter (const YCPValue& arg, const int position);
    constTypePtr wantedParameterType () const;
    bool appendParameter (const YCPValue& arg);
    bool finishParameters ();
    YCPValue evaluateCall ();
    YCPValue evaluateCall_int ();
    bool reset ();
    string name () const;
};

class Y2UIOverloadedFunction: public Y2UIFunction
{
    vector<SymbolEntryPtr>::iterator m_candidates_b;
    vector<SymbolEntryPtr>::iterator m_candidates_e;

 public:
    Y2UIOverloadedFunction (
        Y2UINamespace* instance, YUIComponent* comp,
        unsigned pos_offset,
        vector<SymbolEntryPtr>::iterator candidates_b,
        vector<SymbolEntryPtr>::iterator candidates_e,
        bool play_macro_blocks);

    // attachParameter, appendParameter, reset from parent: fine   
    // wantedParameterType from parent: kind of fine

    bool finishParameters ();
};

class Y2UINamespace: public Y2Namespace
{
    private:
        void registerFunctions ();
        
        vector<string> _registered_functions;
        
        YUIComponent* m_comp;

    public:
        Y2UINamespace (YUIComponent* comp);

        virtual ~Y2UINamespace ();

        virtual const string name () const
        {
            return "UI";
        }

        virtual const string filename () const
        {
            return "UI";
        }

        virtual string toString () const
        {
            return "// not possible toString";
        }

        virtual YCPValue evaluate (bool cse = false )
        {
            if (cse) return YCPNull ();
            else return YCPVoid ();
        }

        virtual Y2Function* createFunctionCall (const string name, constFunctionTypePtr type);

        /* TYPEINFO: void (string) */
        YCPValue SetLanguage ( const YCPString & language );

        /* TYPEINFO: void (string, string) */
        YCPValue SetLanguage ( const YCPString & language, const YCPString & encoding );

        /* TYPEINFO: string () */
        YCPValue GetProductName ();

        /* TYPEINFO: void (string) */
        YCPValue SetProductName ( const YCPString & name );

        /* TYPEINFO: void (string, string, string, string, string) */
        YCPValue SetConsoleFont ( const YCPString & console_magic, const YCPString & font, const YCPString & screen_map, const YCPString & unicode_map, const YCPString & encoding );

        /* TYPEINFO: void () */
        YCPValue SetKeyboard ();

        /* TYPEINFO: string (boolean) */
        YCPValue GetLanguage ( const YCPBoolean & strip );

        /* TYPEINFO: any() */
        YCPValue UserInput();

        /* TYPEINFO: any () */
        YCPValue PollInput ();

        /* TYPEINFO: any (integer) */
        YCPValue TimeoutUserInput ( const YCPInteger& timeout );

        /* TYPEINFO: map<string,any> () */
        YCPValue WaitForEvent ();

        /* TYPEINFO: map<string,any> (integer) */
        YCPValue WaitForEvent( const YCPInteger & timeout );

        /* TYPEINFO: void(term) */
        YCPValue OpenDialog( const YCPTerm & dialog_term );

        /* TYPEINFO: void(term,term) */
        YCPValue OpenDialog( const YCPTerm & opts, const YCPTerm & dialog_term );

        /* TYPEINFO: boolean() */
        YCPValue CloseDialog();

        // TODO DECL_NIL?
        /* TYPEINFO: boolean (symbol, symbol, any) */
        YCPValue ChangeWidget ( const YCPSymbol & widget_id, const YCPSymbol & property, const YCPValue & new_value );

        // TODO DECL_NIL?
        /* TYPEINFO: boolean (term, symbol, any) */
        YCPValue ChangeWidget ( const YCPTerm & widget_id, const YCPSymbol & property, const YCPValue & new_value );

        // TODO DECL_NIL?
        /* TYPEINFO: boolean (term, term, any) */
        YCPValue ChangeWidget ( const YCPTerm & widget_id, const YCPTerm & property, const YCPValue & new_value );

        /* TYPEINFO: any (symbol, symbol) */
        YCPValue QueryWidget ( const YCPSymbol & widget_id, const YCPSymbol & property );

        /* TYPEINFO: any (symbol, term) */
        YCPValue QueryWidget ( const YCPSymbol & widget_id, const YCPTerm & property );

        /* TYPEINFO: any (term, symbol) */
        YCPValue QueryWidget ( const YCPTerm & widget_id, const YCPSymbol & property );

        /* TYPEINFO: any (term, term) */
        YCPValue QueryWidget ( const YCPTerm & widget_id, const YCPTerm & property );

        /* TYPEINFO: boolean (symbol, term) */
        YCPValue ReplaceWidget ( const YCPSymbol & widget_id, const YCPTerm & new_widget );

        /* TYPEINFO: boolean (term, term) */
        YCPValue ReplaceWidget ( const YCPTerm & widget_id, const YCPTerm & new_widget );

        /* TYPEINFO: boolean (symbol) */
        YCPValue SetFocus ( const YCPSymbol & widget_id );

        /* TYPEINFO: boolean (term) */
        YCPValue SetFocus ( const YCPTerm & widget_id );

        /* TYPEINFO: integer (string) */
        YCPValue RunInTerminal ( const YCPString & command );

        /* TYPEINFO: void () */
        YCPValue BusyCursor ();

        /* TYPEINFO: void () */
        YCPValue RedrawScreen ();

        /* TYPEINFO: void () */
        YCPValue NormalCursor ();

        /* TYPEINFO: void (string) */
        YCPValue MakeScreenShot ( const YCPString & filename );

        /* TYPEINFO: void () */
        YCPValue MakeScreenShot ();

        /* TYPEINFO: void () */
        YCPValue DumpWidgetTree ();

        /* TYPEINFO: void () */
        YCPValue Beep ();

        /* TYPEINFO: void (string) */
        YCPValue RecordMacro ( const YCPString & filename );

        /* TYPEINFO: void () */
        YCPValue StopRecordMacro ();

        /* TYPEINFO: void (string) */
        YCPValue PlayMacro ( const YCPString & filename );

        /* TYPEINFO: void () */
        YCPValue FakeUserInput ();

        /* TYPEINFO: void (any) */
        YCPValue FakeUserInput ( const YCPValue & next_input );

        /* TYPEINFO: string (symbol) */
        YCPValue Glyph ( const YCPSymbol & glyphSym  );

        /* TYPEINFO: map<string,any> () */
        YCPValue GetDisplayInfo ();

        /* TYPEINFO: void () */
        YCPValue RecalcLayout ();

        /* TYPEINFO: void () */
        YCPValue PostponeShortcutCheck ();

        /* TYPEINFO: void () */
        YCPValue CheckShortcuts ();

        /* TYPEINFO: boolean (symbol) */
        YCPValue WidgetExists ( const YCPSymbol & widget_id );

        /* TYPEINFO: boolean (term) */
        YCPValue WidgetExists ( const YCPTerm & widget_id );

        /* TYPEINFO: any (term) */
        YCPValue RunPkgSelection ( const YCPValue & widget_id );

        /* TYPEINFO: string (string, string) */
        YCPValue AskForExistingDirectory ( const YCPString & startDir, const YCPString & headline );

        /* TYPEINFO: string (string, string, string) */
        YCPValue AskForExistingFile ( const YCPString & startWith, const YCPString & filter, const YCPString & headline  );

        /* TYPEINFO: string (string, string, string) */
        YCPValue AskForSaveFileName ( const YCPString & startWith, const YCPString & filter, const YCPString & headline );

        /* TYPEINFO: void (map<string,integer>) */
        YCPValue SetFunctionKeys ( const YCPMap & new_fkeys );

        /* TYPEINFO: any (string, string, string) */
        YCPValue Recode ( const YCPString & from, const YCPString & to, const YCPString & text );

        /* TYPEINFO: void (string) */
        YCPValue SetModulename ( const YCPString & name );

        /* TYPEINFO: boolean (symbol) */
        YCPValue HasSpecialWidget ( const YCPSymbol & widget );

        /* TYPEINFO: boolean (term) */
        YCPValue WizardCommand ( const YCPTerm & command );

        /* TYPEINFO:list<map<string,any>> () */
        YCPValue CollectUserInput ();

        /* TYPEINFO:list<map<string,any>> (term) */
        YCPValue CollectUserInput( const YCPTerm & widget_id );

YCPValue
CallHandler( void * ptr, int argc, YCPValue argv[] );

};

---