script.h-Dateireferenz

Dieser Graph zeigt, welche Datei direkt oder indirekt diese Datei enthält:

gehe zum Quellcode dieser Datei

Datenstrukturen
struct	_sc_param

Makrodefinitionen
#define	DTYPE_INT   0
#define	DTYPE_TABLE   1

Typdefinitionen
typedef struct _sc_param	sc_param

Aufzählungen
enum	{ SCRIPT_STATE_INACTIVE =0, SCRIPT_STATE_RAN, SCRIPT_STATE_INTERRUPTED }

Funktionen
void	script_load (const char *fn)
void	save_params_values (int enforce)
void	script_console_add_line (long str_id)
void	script_console_add_error (long str_id)
void	script_print_screen_statement (int val)
void	script_get_alt_text (char *buf)
void	script_set_terminate_key (int key, const char *keyname)
int	script_is_running ()
long	script_stack_start ()
long	script_start_gui (int autostart)
void	script_check_terminate (void)
void	script_wait_terminate (void)
void	script_end ()

Variablen
char	script_title [36]
sc_param *	script_params

Makro-Dokumentation

#define DTYPE_INT   0

Definiert in Zeile 19 der Datei script.h.

#define DTYPE_TABLE   1

Definiert in Zeile 20 der Datei script.h.

Dokumentation der benutzerdefinierten Typen

typedef struct _sc_param sc_param

Dokumentation der Aufzählungstypen

anonymous enum

Aufzählungswerte
SCRIPT_STATE_INACTIVE
SCRIPT_STATE_RAN
SCRIPT_STATE_INTERRUPTED

Definiert in Zeile 12 der Datei script.h.

     {  SCRIPT_STATE_INACTIVE=0,  // 0 - script is inactive now
        SCRIPT_STATE_RAN,         // 1 - script works now
        SCRIPT_STATE_INTERRUPTED, // 2 - shutter button was pressed, cancel script
};

Dokumentation der Funktionen

void save_params_values

(

int

enforce)

Definiert in Zeile 677 der Datei gui_script.c.

{
    if (conf.script_param_save && (conf.script_param_set != DEFAULT_PARAM_SET))
    {
        // Write paramsetnum file
        if (conf.script_param_set != last_script_param_set)
        {
            char *nm = make_param_filename(MAKE_PARAMSETNUM_FILENAME);
            save_int_value_file( nm, conf.script_param_set );
            last_script_param_set = conf.script_param_set;
        }

        int changed=0;

        // Check is anything changed since last time
        sc_param *p = script_params;
        while (p)
        {
            if (p->old_val != p->val)
            {
                changed++;
                p->old_val = p->val;
            }
            p = p->next;
        }

        if (enforce || changed)
        {
            // Write parameters file
            do_save_param_file();
        }
    }
}

void script_check_terminate

(

void

)

Definiert in Zeile 162 der Datei script.c.

{
    if(camera_info.state.state_kbd_script_run && script_terminate_request) {
        script_console_add_error(LANG_CONSOLE_TEXT_TERMINATED);
        script_end();
    }
}

void script_console_add_error

(

long

str_id)

Definiert in Zeile 94 der Datei script.c.

{
    console_set_autoredraw(1);          // Force console display on
    script_console_add_line(str_id);
}

void script_console_add_line

(

long

str_id)

Definiert in Zeile 81 der Datei script.c.

{
    const char* str = lang_str(str_id);
    console_add_line(str);

    if (print_screen_p && (print_screen_d >= 0)) {
        char nl = '\n';
        // TODO this should be uncached memory
        write(print_screen_d, str, strlen(str) );
        write(print_screen_d, &nl, 1);
    }
}

void script_end

(

)

Definiert in Zeile 230 der Datei script.c.

{
    // Tell other code that script has ended
    camera_info.state.state_kbd_script_run = SCRIPT_STATE_INACTIVE;
    camera_info.state.osd_title_line = 1 ;

    // reset the script terminate key
    script_terminate_key = KEY_SHOOT_FULL ;

    script_print_screen_end();
    console_set_autoredraw(1);          // Force console display on in case script turned it off

    // Restore old handler - prevent calling MD draw after module unloaded
    if (old_gui_handler)
    {
        extern gui_handler defaultGuiHandler; 
        // if script switched in or out of alt, try to preserve
        // TODO is there ever a situation where it should be something other than default or alt?
        if(old_gui_handler == &altGuiHandler && camera_info.state.gui_mode_none) {
            gui_set_mode(&defaultGuiHandler);
        } else if(old_gui_handler == &defaultGuiHandler && camera_info.state.gui_mode_alt) {
            gui_set_mode(&altGuiHandler);
        } else {
            gui_set_mode(old_gui_handler);
        }
        old_gui_handler = 0;
    }

    // Reset script language module
    libscriptapi->script_reset();

    // Kill off the action_stack for the script, since we've just reset the script
    // language and unloaded the MD module, we don't need to let the stack empty
    // itself.
    action_stack_kill(running_script_stack_name);
    running_script_stack_name = -1;

    libshothisto->shot_histogram_set(0);
    kbd_key_release_all();

    conf_setAutosave(1);    // Turn on autosave of config file in conf_setValue in case script turned it off
    conf_update_prevent_shutdown();
}

void script_get_alt_text

(

char *

buf)

Definiert in Zeile 148 der Datei script.c.

{
    if ((script_terminate_key != KEY_SHOOT_FULL) && camera_info.state.state_kbd_script_run)
    {
        sprintf(buf,"<EXIT=%s>",script_terminate_key_name);
    }
    else
    {
        strcpy(buf,"<ALT>");
    }
}

int script_is_running

(

)

Definiert in Zeile 135 der Datei script.c.

{
    return !action_stack_is_finished(running_script_stack_name);
}

void script_load

(

const char *

fn)

Definiert in Zeile 734 der Datei gui_script.c.

{
    // if filename is empty, try to load default named script.
    // if no such one, no script will be used
    if ((fn == 0) || (fn[0] == 0))
        fn = SCRIPT_DEFAULT_FILENAME;

    strcpy(conf.script_file, fn);

    get_last_paramset_num();    // update data paths
    script_scan();              // re-fill @title/@names/@range/@value + reset values to @default
    load_params_values();

    gui_update_script_submenu();
}

void script_print_screen_statement

(

int

val)

Definiert in Zeile 60 der Datei script.c.

{
  // Negative values for 'val' parameter will append to log file,
  // positive values will truncate the log file
  int flag_trunc = O_TRUNC;

  print_screen_p = val;
  if (val) {
    if (print_screen_d>=0) close(print_screen_d);
    if (val<0) {
       flag_trunc = 0;
       val = -val;
    }
    while (val > 9999) val -= 10000;
    sprintf(print_screen_file, "A/CHDK/LOGS/LOG_%04d.TXT", val);
    print_screen_d = open(print_screen_file, O_WRONLY|O_CREAT|flag_trunc, 0777);
    if (print_screen_d>=0) lseek(print_screen_d,0,SEEK_END);
  }
  else script_print_screen_end() ;
}

void script_set_terminate_key	(	int	key,
		const char *	keyname
	)

Definiert in Zeile 141 der Datei script.c.

{
    script_terminate_key = key;
    strncpy(script_terminate_key_name,keyname,sizeof(script_terminate_key_name));
    script_terminate_key_name[sizeof(script_terminate_key_name)-1] = 0;
}

long script_stack_start

(

)

Definiert in Zeile 126 der Datei script.c.

{
    script_terminate_request = 0; // ensure any previous terminate request is cleared

    camera_info.state.state_kbd_script_run = SCRIPT_STATE_RAN;
    running_script_stack_name = action_stack_create(&action_stack_AS_SCRIPT_RUN);
    return running_script_stack_name;
}

long script_start_gui

(

int

autostart)

Definiert in Zeile 274 der Datei script.c.

{
    if (conf.script_file[0] == 0) return 0;

    libshothisto->shot_histogram_set(0);
    camera_info.state.auto_started = autostart;

    // Kill high speed USB timer if running
    stop_usb_HPtimer();

    // Keyboard init
    camera_info.state.kbd_last_clicked = 0;
    camera_info.state.kbd_last_checked_time = get_tick_count();
    kbd_key_release_all();

    // Close old console, will be re-opened when first line added
    console_close();
    script_print_screen_init();

    save_params_values(0);

    script_console_add_line((autostart)?LANG_CONSOLE_TEXT_AUTOSTARTED:LANG_CONSOLE_TEXT_STARTED);

    module_set_script_lang(conf.script_file);
    if ( !libscriptapi->script_start_file(conf.script_file) )
    {
        return -1;
    }

    sc_param *p = script_params;
    while (p)
    {
        if (p->name != 0)
        {
            libscriptapi->set_variable(p->name, p->val, (p->range == 1), (p->data_type == DTYPE_TABLE), p->option_count, p->options);
        }
        p = p->next;
    }

    conf_update_prevent_shutdown();

    old_gui_handler = gui_set_mode(&scriptGuiHandler);

    return script_stack_start();
}

void script_wait_terminate

(

void

)

Definiert in Zeile 217 der Datei script.c.

{
    if(camera_info.state.state_kbd_script_run == SCRIPT_STATE_INACTIVE) {
        return;
    }
    script_terminate_request = 1;
    // TODO timeout?
    while(camera_info.state.state_kbd_script_run != SCRIPT_STATE_INACTIVE) {
        msleep(10);
    }
}

Variablen-Dokumentation

sc_param* script_params

Definiert in Zeile 38 der Datei gui_script.c.

char script_title[36]

Definiert in Zeile 29 der Datei gui_script.c.