build(deps): bump github/codeql-action from 3.28.18 to 3.29.2

[thirdparty/systemd.git] / src / shared / output-mode.h

/* SPDX-License-Identifier: LGPL-2.1-or-later */
#pragma once

#include "forward.h"

typedef enum OutputMode {
        OUTPUT_SHORT,
        OUTPUT_SHORT_FULL,
        OUTPUT_SHORT_ISO,
        OUTPUT_SHORT_ISO_PRECISE,
        OUTPUT_SHORT_PRECISE,
        OUTPUT_SHORT_MONOTONIC,
        OUTPUT_SHORT_DELTA,
        OUTPUT_SHORT_UNIX,
        OUTPUT_VERBOSE,
        OUTPUT_EXPORT,
        OUTPUT_JSON,
        OUTPUT_JSON_PRETTY,
        OUTPUT_JSON_SSE,
        OUTPUT_JSON_SEQ,
        OUTPUT_CAT,
        OUTPUT_WITH_UNIT,
        _OUTPUT_MODE_MAX,
        _OUTPUT_MODE_INVALID = -EINVAL,
} OutputMode;

static inline bool OUTPUT_MODE_IS_JSON(OutputMode m) {
        return IN_SET(m, OUTPUT_JSON, OUTPUT_JSON_PRETTY, OUTPUT_JSON_SSE, OUTPUT_JSON_SEQ);
}

/* The output flags definitions are shared by the logs and process tree output. Some apply to both, some only to the
 * logs output, others only to the process tree output. */

typedef enum OutputFlags {
        OUTPUT_SHOW_ALL          = 1 << 0,
        OUTPUT_FULL_WIDTH        = 1 << 1,
        OUTPUT_COLOR             = 1 << 2,

        /* Specific to log output */
        OUTPUT_WARN_CUTOFF       = 1 << 3,
        OUTPUT_CATALOG           = 1 << 4,
        OUTPUT_BEGIN_NEWLINE     = 1 << 5,
        OUTPUT_UTC               = 1 << 6,
        OUTPUT_NO_HOSTNAME       = 1 << 7,
        OUTPUT_TRUNCATE_NEWLINE  = 1 << 8,

        /* Specific to process tree output */
        OUTPUT_KERNEL_THREADS    = 1 << 9,
        OUTPUT_CGROUP_XATTRS     = 1 << 10,
        OUTPUT_CGROUP_ID         = 1 << 11,
} OutputFlags;

sd_json_format_flags_t output_mode_to_json_format_flags(OutputMode m);

const char* output_mode_to_string(OutputMode m) _const_;
OutputMode output_mode_from_string(const char *s) _pure_;