Top | ![]() |
![]() |
![]() |
![]() |
#define | GCUT_EGG_ERROR |
GQuark | gcut_egg_error_quark () |
GCutEgg * | gcut_egg_new () |
GCutEgg * | gcut_egg_new_va_list () |
GCutEgg * | gcut_egg_new_argv () |
GCutEgg * | gcut_egg_new_strings () |
GCutEgg * | gcut_egg_new_array () |
void | gcut_egg_set_flags () |
GSpawnFlags | gcut_egg_get_flags () |
void | gcut_egg_set_env () |
gchar ** | gcut_egg_get_env () |
gboolean | gcut_egg_hatch () |
void | gcut_egg_close () |
gboolean | gcut_egg_write () |
GPid | gcut_egg_get_pid () |
gint | gcut_egg_wait () |
void | gcut_egg_kill () |
GIOChannel * | gcut_egg_get_input () |
GIOChannel * | gcut_egg_get_output () |
GIOChannel * | gcut_egg_get_error () |
guint | gcut_egg_get_forced_termination_wait_time () |
void | gcut_egg_set_forced_termination_wait_time () |
void | error | Run Last |
void | error-received | Run Last |
void | output-received | Run Last |
void | reaped | Run Last |
GCutEggは外部コマンドの実行・通信・終了をカプセル化します。GCutEggはエラーをGErrorとして報告します。エラーはgcut_assert_error()
を使うことにより簡単に検証できます。
外部コマンドはgcut_egg_new()
、gcut_egg_new_strings()
などのようなコンストラクタで指定します。この時点では外部コマンドは実行されません。gcut_egg_hatch()
で指定された外部コマンドが実行されます。
Standard/Error outputs of external command are passed by
“output-received”/“error-received” signals
or GIOChannel returned by
gcut_egg_get_output()
/gcut_egg_get_error()
.
gcut_egg_write()
writes a chunk to standard input of
external command.
外部コマンドの終了を待つためにはgcut_egg_wait()
を使うことができます。無限待ちを避けるために、タイムアウトを指定することができます。
例:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
static GString *output_string; static GCutEgg *egg; void cut_setup (void) { output_string = g_string_new(NULL); egg = NULL; } void cut_teardown (void) { if (output_string) g_string_free(output_string, TRUE); if (egg) g_object_unref(egg); } static void cb_output_received (GCutEgg *egg, const gchar *chunk, gsize size, gpointer user_data) { g_string_append_len(output_string, chunk, size); } void test_echo (void) { GError *error = NULL; egg = gcut_egg_new("echo", "XXX", NULL); g_signal_connect(egg, "output-received", G_CALLBACK(cb_output_received), NULL); gcut_egg_hatch(egg, &error); gcut_assert_error(error); gcut_egg_wait(egg, 1000, &error); gcut_assert_error(error); cut_assert_equal_string("XXX\n", output_string->str); } |
#define GCUT_EGG_ERROR (gcut_egg_error_quark())
GCUT_EGG_ERROR
は非推奨です。新しいコードでは使わないでください。
GQuark
gcut_egg_error_quark (void
);
gcut_egg_error_quark
は非推奨です。新しいコードでは使わないでください。
GCutEgg * gcut_egg_new (const gchar *command
,...
);
gcut_egg_new
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_new()
instead.
Creates a new GCutEgg object that runs command
.
Since: 1.0.6
GCutEgg * gcut_egg_new_va_list (const gchar *command
,va_list args
);
gcut_egg_new_va_list
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_new_va_list()
instead.
Creates a new GCutEgg object that runs command
.
Since: 1.0.6
GCutEgg * gcut_egg_new_argv (gint argc
,gchar **argv
);
gcut_egg_new_argv
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_new_argv()
instead.
Creates a new GCutEgg object that runs command
.
Since: 1.0.6
GCutEgg *
gcut_egg_new_strings (const gchar **command
);
gcut_egg_new_strings
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_new_strings()
instead.
Creates a new GCutEgg object that runs command
.
Since: 1.0.6
GCutEgg *
gcut_egg_new_array (GArray *command
);
gcut_egg_new_array
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_new_array()
instead.
Creates a new GCutEgg object that runs command
.
Since: 1.0.6
void gcut_egg_set_flags (GCutEgg *egg
,GSpawnFlags flags
);
gcut_egg_set_flags
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_set_flags()
instead.
外部コマンドを実行するときのflags
を設定します。
Since: 1.0.6
GSpawnFlags
gcut_egg_get_flags (GCutEgg *egg
);
gcut_egg_get_flags
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_get_flags()
instead.
外部コマンドを実行する時のflags
を取得します。
Since: 1.0.6
void gcut_egg_set_env (GCutEgg *egg
,const gchar *name
,...
);
gcut_egg_set_env
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_set_env()
instead.
外部コマンドの環境変数を設定します。
Since: 1.0.6
gchar **
gcut_egg_get_env (GCutEgg *egg
);
gcut_egg_get_env
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_get_env()
instead.
外部コマンドの環境変数を取得します。
新しく割り当てられたNULL
終端の環境変数のリスト("名前1=値1", "名前2=値2", ..., NULL
)を返します。必要がなくなったらg_strfreev()
で開放してください。
Since: 1.0.6
gboolean gcut_egg_hatch (GCutEgg *egg
,GError **error
);
gcut_egg_hatch
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_run()
instead.
新しい外部プロセスを実行します。
Since: 1.0.6
void
gcut_egg_close (GCutEgg *egg
);
gcut_egg_close
has been deprecated since version 1.1.5 and should not be used in newly-written code.
no need to close explicitly on GCutProcess.
実行した外部コマンドのリソースを回収します。破棄されるときに暗黙的に回収されます。
Since: 1.0.6
gboolean gcut_egg_write (GCutEgg *egg
,const gchar *chunk
,gsize size
,GError **error
);
gcut_egg_write
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_write()
instead.
外部プロセスの標準入力にchunk
を書き込みます。
Since: 1.0.6
GPid
gcut_egg_get_pid (GCutEgg *egg
);
gcut_egg_get_pid
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_get_pid()
instead.
実行している外部プロセスのプロセスIDを取得します。外部コマンドが実行されていない場合は0が返ります。
Since: 1.0.6
gint gcut_egg_wait (GCutEgg *egg
,guint timeout
,GError **error
);
gcut_egg_wait
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_wait()
instead.
実行中の外部プロセスが終了することをtimeout
ミリ秒待ちます。外部コマンドがtimeout
ミリ秒以内に終了しなかった場合は、GCUT_EGG_ERROR_TIMEOUT
エラーが設定され、-1が返ります。外部プロセスが実行されていない場合は、GCUT_EGG_ERROR_NOT_RUNNING
エラーが設定され、-1が返ります。
Since: 1.0.6
void gcut_egg_kill (GCutEgg *egg
,gint signal_number
);
gcut_egg_kill
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_kill()
instead.
外部プロセスにsignal_number
シグナルを送ります。
Since: 1.0.6
GIOChannel *
gcut_egg_get_input (GCutEgg *egg
);
gcut_egg_get_input
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_get_input_channel()
instead.
外部プロセスの標準入力と結びついたGIOChannelを取得します。
Since: 1.0.6
GIOChannel *
gcut_egg_get_output (GCutEgg *egg
);
gcut_egg_get_output
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_get_output_channel()
instead.
外部プロセスの標準出力と結びついたGIOChannelを取得します。
Since: 1.0.6
GIOChannel *
gcut_egg_get_error (GCutEgg *egg
);
gcut_egg_get_error
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_get_error_channel()
instead.
外部プロセスのエラー出力に結びついたGIOChannelを返します。
Since: 1.0.6
guint
gcut_egg_get_forced_termination_wait_time
(GCutEgg *egg
);
gcut_egg_get_forced_termination_wait_time
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_get_forced_termination_wait_time()
instead.
オブジェクトが破棄されるときに行われる外部コマンド強制終了後に待つ時間(ミリ秒)を取得します。
Since: 1.0.6
void gcut_egg_set_forced_termination_wait_time (GCutEgg *egg
,guint timeout
);
gcut_egg_set_forced_termination_wait_time
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use gcut_process_set_forced_termination_wait_time()
instead.
オブジェクトが破棄されるときに行われる外部コマンド強制終了時に待つ時間(ミリ秒)を設定します。timeout
が0なら外部コマンドの終了を待ちません。デフォルト値は10です。
Since: 1.0.6
GCutEggError
has been deprecated since version 1.1.5 and should not be used in newly-written code.
Use GCutProcessError instead.
GCutEgg関連の操作で返されるエラーコード。
コマンドライン関連のエラー。 |
||
入出力エラー。 |
||
外部コマンドはすでに実行されています。 |
||
外部こもアンドが実行されていません。 |
||
不正なGCutEggオブジェクトが渡されました。 |
||
タイムアウト。 |
Since: 1.0.6
“error”
signalvoid user_function (GCutEgg *egg, gpointer error, gpointer user_data)
Flags: Run Last
Since: 1.0.6
“error-received”
signalvoid user_function (GCutEgg *egg, gchar *chunk, guint64 size, gpointer user_data)
Flags: Run Last
Since: 1.0.6
“output-received”
signalvoid user_function (GCutEgg *egg, gchar *chunk, guint64 size, gpointer user_data)
Flags: Run Last
Since: 1.0.6