milter-utils 3 milter managerライブラリ
milter-utils

## Functions

#define | MILTER_IMPLEMENT_ERROR_EMITTABLE()
#define | MILTER_DEFINE_ERROR_EMITTABLE_TYPE()
#define | MILTER_IMPLEMENT_FINISHED_EMITTABLE_WITH_CODE()
#define | MILTER_IMPLEMENT_FINISHED_EMITTABLE()
#define | MILTER_DEFINE_FINISHED_EMITTABLE_TYPE()
#define | MILTER_IMPLEMENT_REPLY_SIGNALS()
gchar * | milter_utils_inspect_io_condition_error ()
gchar * | milter_utils_inspect_enum ()
gchar * | milter_utils_get_enum_name ()
gchar * | milter_utils_get_enum_nick_name ()
gchar * | milter_utils_inspect_flags ()
gchar * | milter_utils_get_flags_names ()
gchar * | milter_utils_inspect_object ()
gchar * | milter_utils_format_reply_code ()
gchar * | milter_utils_inspect_hash_string_string ()
void | milter_utils_merge_hash_string_string ()
gchar * | milter_utils_inspect_list_pointer ()
MilterMacroStage | milter_utils_command_to_macro_stage ()
MilterCommand | milter_utils_macro_stage_to_command ()
void | milter_utils_set_error_with_sub_error ()
guint | milter_utils_flags_from_string ()
gint | milter_utils_enum_from_string ()
void | milter_utils_append_indent ()
void | milter_utils_xml_append_text_element ()
void | milter_utils_xml_append_boolean_element ()
void | milter_utils_xml_append_enum_element ()
gint | milter_utils_strcmp0 ()
gboolean | milter_utils_detach_io ()
gboolean | milter_utils_guess_console_color_usability ()
gboolean | milter_utils_parse_file_mode ()
GQuark | milter_enum_error_quark ()
GQuark | milter_flags_error_quark ()

## Types and Values

enum | MilterUtilsPipeMode
#define | MILTER_ENUM_ERROR
#define | MILTER_FLAGS_ERROR
enum | MilterEnumError
enum | MilterFlagsError

## 説明

## Functions

### MILTER_IMPLEMENT_ERROR_EMITTABLE()

    #define             MILTER_IMPLEMENT_ERROR_EMITTABLE(init)

MILTER_IMPLEMENT_ERROR_EMITTABLE

### MILTER_DEFINE_ERROR_EMITTABLE_TYPE()

    #define             MILTER_DEFINE_ERROR_EMITTABLE_TYPE(TypeName, type_name, TYPE_PARENT)

MILTER_DEFINE_ERROR_EMITTABLE_TYPE

### MILTER_IMPLEMENT_FINISHED_EMITTABLE_WITH_CODE()

    #define             MILTER_IMPLEMENT_FINISHED_EMITTABLE_WITH_CODE(init, code)

MILTER_IMPLEMENT_FINISHED_EMITTABLE_WITH_CODE

### MILTER_IMPLEMENT_FINISHED_EMITTABLE()

    #define             MILTER_IMPLEMENT_FINISHED_EMITTABLE(init)

MILTER_IMPLEMENT_FINISHED_EMITTABLE

### MILTER_DEFINE_FINISHED_EMITTABLE_TYPE()

    #define             MILTER_DEFINE_FINISHED_EMITTABLE_TYPE(TypeName,                     \
                                                              type_name,                    \
                                                              TYPE_PARENT)

MILTER_DEFINE_FINISHED_EMITTABLE_TYPE

### MILTER_IMPLEMENT_REPLY_SIGNALS()

    #define             MILTER_IMPLEMENT_REPLY_SIGNALS(init)

MILTER_IMPLEMENT_REPLY_SIGNALS

### milter_utils_inspect_io_condition_error ()

    gchar *
    milter_utils_inspect_io_condition_error
                                   (GIOCondition condition);

milter_utils_inspect_io_condition_error

### milter_utils_inspect_enum ()

    gchar *
    milter_utils_inspect_enum (GType enum_type,
                               gint enum_value);

milter_utils_inspect_enum

### milter_utils_get_enum_name ()

    gchar *
    milter_utils_get_enum_name (GType enum_type,
                                gint enum_value);

milter_utils_get_enum_name

### milter_utils_get_enum_nick_name ()

    gchar *
    milter_utils_get_enum_nick_name (GType enum_type,
                                     gint enum_value);

milter_utils_get_enum_nick_name

### milter_utils_inspect_flags ()

    gchar *
    milter_utils_inspect_flags (GType flags_type,
                                guint flags);

milter_utils_inspect_flags

### milter_utils_get_flags_names ()

    gchar *
    milter_utils_get_flags_names (GType flags_type,
                                  guint flags);

milter_utils_get_flags_names

### milter_utils_inspect_object ()

    gchar *
    milter_utils_inspect_object (GObject *object);

milter_utils_inspect_object

### milter_utils_format_reply_code ()

    gchar *
    milter_utils_format_reply_code (guint reply_code,
                                    const gchar *extended_code,
                                    const gchar *message);

milter_utils_format_reply_code

### milter_utils_inspect_hash_string_string ()

    gchar *
    milter_utils_inspect_hash_string_string
                                   (GHashTable *hash);

milter_utils_inspect_hash_string_string

### milter_utils_merge_hash_string_string ()

    void
    milter_utils_merge_hash_string_string (GHashTable *dest,
                                           GHashTable *src);

milter_utils_merge_hash_string_string

### milter_utils_inspect_list_pointer ()

    gchar *
    milter_utils_inspect_list_pointer (const GList *list);

[skip]

#### Parameters

list | A GList to be inspected. | [element-type void*]

#### Returns

The string that inspects the give list.

It should be freed with `g_free()` when no longer needed.

milter_utils_inspect_list_pointer

### milter_utils_command_to_macro_stage ()

    MilterMacroStage
    milter_utils_command_to_macro_stage (MilterCommand command);

milter_utils_command_to_macro_stage

### milter_utils_macro_stage_to_command ()

    MilterCommand
    milter_utils_macro_stage_to_command (MilterMacroStage stage);

milter_utils_macro_stage_to_command

### milter_utils_set_error_with_sub_error ()

    void
    milter_utils_set_error_with_sub_error (GError **error,
                                           GQuark domain,
                                           gint error_code,
                                           GError *sub_error,
                                           const gchar *format,
                                           ...);

milter_utils_set_error_with_sub_error

### milter_utils_flags_from_string ()

    guint
    milter_utils_flags_from_string (GType flags_type,
                                    const gchar *flags_string,
                                    guint base_flags,
                                    guint default_flags,
                                    GError **error);

milter_utils_flags_from_string

### milter_utils_enum_from_string ()

    gint
    milter_utils_enum_from_string (GType enum_type,
                                   const gchar *enum_string,
                                   GError **error);

milter_utils_enum_from_string

### milter_utils_append_indent ()

    void
    milter_utils_append_indent (GString *string,
                                guint size);

milter_utils_append_indent

### milter_utils_xml_append_text_element ()

    void
    milter_utils_xml_append_text_element (GString *string,
                                          const gchar *name,
                                          const gchar *content,
                                          guint indent);

milter_utils_xml_append_text_element

### milter_utils_xml_append_boolean_element ()

    void
    milter_utils_xml_append_boolean_element
                                   (GString *string,
                                    const gchar *name,
                                    gboolean boolean,
                                    guint indent);

milter_utils_xml_append_boolean_element

### milter_utils_xml_append_enum_element ()

    void
    milter_utils_xml_append_enum_element (GString *string,
                                          const gchar *name,
                                          GType enum_type,
                                          gint enum_value,
                                          guint indent);

milter_utils_xml_append_enum_element

### milter_utils_strcmp0 ()

    gint
    milter_utils_strcmp0 (const gchar *str1,
                          const gchar *str2);

milter_utils_strcmp0

### milter_utils_detach_io ()

    gboolean
    milter_utils_detach_io (gchar **message);

milter_utils_detach_io

### milter_utils_guess_console_color_usability ()

    gboolean
    milter_utils_guess_console_color_usability
                                   (void);

milter_utils_guess_console_color_usability

### milter_utils_parse_file_mode ()

    gboolean
    milter_utils_parse_file_mode (const gchar *string,
                                  guint *mode,
                                  gchar **error_message);

Parses mode string such as "u+rw".

#### Parameters

string | a mode string to be parsed. |
mode | return location for parsed mode. | [out]
error_message | return location for error message on error. | [out]

#### Returns

`TRUE` on success, `FALSE` otherwise.

milter_utils_parse_file_mode

### milter_enum_error_quark ()

    GQuark
    milter_enum_error_quark (void);

milter_enum_error_quark

### milter_flags_error_quark ()

    GQuark
    milter_flags_error_quark (void);

milter_flags_error_quark

## Types and Values

### enum MilterUtilsPipeMode

#### Members

MILTER_UTILS_READ_PIPE |  |
MILTER_UTILS_WRITE_PIPE |  |

MilterUtilsPipeMode

### MILTER_ENUM_ERROR

    #define MILTER_ENUM_ERROR           (milter_enum_error_quark())

MILTER_ENUM_ERROR

### MILTER_FLAGS_ERROR

    #define MILTER_FLAGS_ERROR          (milter_flags_error_quark())

MILTER_FLAGS_ERROR

### enum MilterEnumError

#### Members

MILTER_ENUM_ERROR_NULL_NAME |  |
MILTER_ENUM_ERROR_UNKNOWN_NAME |  |

MilterEnumError

### enum MilterFlagsError

#### Members

MILTER_FLAGS_ERROR_NULL_NAME |  |
MILTER_FLAGS_ERROR_UNKNOWN_NAMES |  |

MilterFlagsError