src/basic/unit-name.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5
   6 #include "macro.h"
   7 #include "unit-def.h"
   8
   9 #define UNIT_NAME_MAX 256
  10
  11 typedef enum UnitNameFlags {
  12         UNIT_NAME_PLAIN    = 1 << 0, /* Allow foo.service */
  13         UNIT_NAME_TEMPLATE = 1 << 1, /* Allow foo@.service */
  14         UNIT_NAME_INSTANCE = 1 << 2, /* Allow foo@bar.service */
  15         UNIT_NAME_ANY = UNIT_NAME_PLAIN|UNIT_NAME_TEMPLATE|UNIT_NAME_INSTANCE,
  16         _UNIT_NAME_INVALID = -EINVAL,
  17 } UnitNameFlags;
  18
  19 bool unit_name_is_valid(const char *n, UnitNameFlags flags) _pure_;
  20 bool unit_prefix_is_valid(const char *p) _pure_;
  21 bool unit_instance_is_valid(const char *i) _pure_;
  22 bool unit_suffix_is_valid(const char *s) _pure_;
  23
  24 int unit_name_to_prefix(const char *n, char **ret);
  25 UnitNameFlags unit_name_to_instance(const char *n, char **ret);
  26 static inline UnitNameFlags unit_name_classify(const char *n) {
  27         return unit_name_to_instance(n, NULL);
  28 }
  29 int unit_name_to_prefix_and_instance(const char *n, char **ret);
  30
  31 UnitType unit_name_to_type(const char *n) _pure_;
  32
  33 int unit_name_change_suffix(const char *n, const char *suffix, char **ret);
  34
  35 int unit_name_build(const char *prefix, const char *instance, const char *suffix, char **ret);
  36 int unit_name_build_from_type(const char *prefix, const char *instance, UnitType type, char **ret);
  37
  38 char *unit_name_escape(const char *f);
  39 int unit_name_unescape(const char *f, char **ret);
  40 int unit_name_path_escape(const char *f, char **ret);
  41 int unit_name_path_unescape(const char *f, char **ret);
  42
  43 int unit_name_replace_instance_full(
  44                 const char *original,
  45                 const char *instance,
  46                 bool accept_glob,
  47                 char **ret);
  48 static inline int unit_name_replace_instance(const char *original, const char *instance, char **ret) {
  49         return unit_name_replace_instance_full(original, instance, false, ret);
  50 }
  51
  52 int unit_name_template(const char *f, char **ret);
  53
  54 int unit_name_hash_long(const char *name, char **ret);
  55 bool unit_name_is_hashed(const char *name);
  56
  57 int unit_name_from_path(const char *path, const char *suffix, char **ret);
  58 int unit_name_from_path_instance(const char *prefix, const char *path, const char *suffix, char **ret);
  59 int unit_name_to_path(const char *name, char **ret);
  60
  61 typedef enum UnitNameMangle {
  62         UNIT_NAME_MANGLE_GLOB = 1 << 0,
  63         UNIT_NAME_MANGLE_WARN = 1 << 1,
  64 } UnitNameMangle;
  65
  66 int unit_name_mangle_with_suffix(const char *name, const char *operation, UnitNameMangle flags, const char *suffix, char **ret);
  67
  68 static inline int unit_name_mangle(const char *name, UnitNameMangle flags, char **ret) {
  69         return unit_name_mangle_with_suffix(name, NULL, flags, ".service", ret);
  70 }
  71
  72 int slice_build_parent_slice(const char *slice, char **ret);
  73 int slice_build_subslice(const char *slice, const char *name, char **subslice);
  74 bool slice_name_is_valid(const char *name);
  75
  76 bool unit_name_prefix_equal(const char *a, const char *b);