output.h

Go to the documentation of this file.

/*
 * Copyright 2019 the Pacemaker project contributors
 *
 * The version control history for this file may have further details.
 *
 * This source code is licensed under the GNU Lesser General Public License
 * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
 */

#ifndef CRM_OUTPUT__H
#  define CRM_OUTPUT__H

#ifdef __cplusplus
extern "C" {
#endif

#  include <stdbool.h>
#  include <stdio.h>
#  include <libxml/tree.h>

#  include <glib.h>
#  include <crm/common/results.h>

#  define PCMK__API_VERSION "1.0"

/* Add to the long_options block in each tool to get the formatted output
 * command line options added.  Then call pcmk__parse_output_args to handle
 * them.
 */
#  define PCMK__OUTPUT_OPTIONS(fmts) \
    {   "output-as", required_argument, NULL, 0, \
        "Specify the format for output, one of: " fmts \
    }, \
    {   "output-to", required_argument, NULL, 0, \
        "Specify the destination for formatted output, \"-\" for stdout or a filename" \
    }

typedef struct pcmk__output_s pcmk__output_t;

typedef pcmk__output_t * (*pcmk__output_factory_t)(char **argv);

typedef int (*pcmk__message_fn_t)(pcmk__output_t *out, va_list args);

typedef struct pcmk__message_entry_s {
    const char *message_id;

    const char *fmt_name;

    pcmk__message_fn_t fn;
} pcmk__message_entry_t;

/* Basic formatters everything supports.  This block needs to be updated every
 * time a new base formatter is added.
 */
pcmk__output_t *pcmk__mk_text_output(char **argv);
pcmk__output_t *pcmk__mk_xml_output(char **argv);

struct pcmk__output_s {
    char *fmt_name;

    char *request;

    bool supports_quiet;

    FILE *dest;

    GHashTable *messages;

    void *priv;

    bool (*init) (pcmk__output_t *out);

    void (*free_priv)(pcmk__output_t *out);

    void (*finish) (pcmk__output_t *out, crm_exit_t exit_status);

    void (*reset) (pcmk__output_t *out);

    void (*register_message) (pcmk__output_t *out, const char *message_id,
                              pcmk__message_fn_t fn);

    int (*message) (pcmk__output_t *out, const char *message_id, ...);

    void (*subprocess_output) (pcmk__output_t *out, int exit_status,
                               const char *proc_stdout, const char *proc_stderr);

    void (*info) (pcmk__output_t *out, const char *format, ...) G_GNUC_PRINTF(2, 3);

    void (*output_xml) (pcmk__output_t *out, const char *name, const char *buf);

    void (*begin_list) (pcmk__output_t *out, const char *name,
                        const char *singular_noun, const char *plural_noun);

    void (*list_item) (pcmk__output_t *out, const char *name, const char *content);

    void (*end_list) (pcmk__output_t *out);
};

int
pcmk__call_message(pcmk__output_t *out, const char *message_id, ...);

void pcmk__output_free(pcmk__output_t *out, crm_exit_t exit_status);

int pcmk__output_new(pcmk__output_t **out, const char *fmt_name,
                     const char *filename, char **argv);

bool
pcmk__parse_output_args(const char *argname, char *argvalue, char **output_ty,
                        char **output_dest);

int
pcmk__register_format(const char *fmt_name, pcmk__output_factory_t create);


void
pcmk__register_message(pcmk__output_t *out, const char *message_id,
                       pcmk__message_fn_t fn);

void
pcmk__register_messages(pcmk__output_t *out, pcmk__message_entry_t *table);

/* Functions that are useful for implementing custom message formatters */

void
pcmk__indented_printf(pcmk__output_t *out, const char *format, ...) G_GNUC_PRINTF(2, 3);

void
pcmk__xml_add_node(pcmk__output_t *out, xmlNodePtr node);

void
pcmk__xml_push_parent(pcmk__output_t *out, xmlNodePtr node);

void
pcmk__xml_pop_parent(pcmk__output_t *out);

#ifdef __cplusplus
}
#endif

#endif