src/basic/unit-name.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   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_INSTANCE = 1 << 1, /* Allow foo@bar.service */
  14         UNIT_NAME_TEMPLATE = 1 << 2, /* Allow foo@.service */
  15         UNIT_NAME_ANY = UNIT_NAME_PLAIN|UNIT_NAME_INSTANCE|UNIT_NAME_TEMPLATE,
  16 } UnitNameFlags;
  17
  18 bool unit_name_is_valid(const char *n, UnitNameFlags flags) _pure_;
  19 bool unit_prefix_is_valid(const char *p) _pure_;
  20 bool unit_instance_is_valid(const char *i) _pure_;
  21 bool unit_suffix_is_valid(const char *s) _pure_;
  22
  23 static inline int unit_prefix_and_instance_is_valid(const char *p) {
  24         /* For prefix+instance and instance the same rules apply */
  25         return unit_instance_is_valid(p);
  26 }
  27
  28 int unit_name_to_prefix(const char *n, char **prefix);
  29 int unit_name_to_instance(const char *n, char **instance);
  30 int unit_name_to_prefix_and_instance(const char *n, char **ret);
  31
  32 UnitType unit_name_to_type(const char *n) _pure_;
  33
  34 int unit_name_change_suffix(const char *n, const char *suffix, char **ret);
  35
  36 int unit_name_build(const char *prefix, const char *instance, const char *suffix, char **ret);
  37 int unit_name_build_from_type(const char *prefix, const char *instance, UnitType, char **ret);
  38
  39 char *unit_name_escape(const char *f);
  40 int unit_name_unescape(const char *f, char **ret);
  41 int unit_name_path_escape(const char *f, char **ret);
  42 int unit_name_path_unescape(const char *f, char **ret);
  43
  44 int unit_name_replace_instance(const char *f, const char *i, char **ret);
  45
  46 int unit_name_template(const char *f, char **ret);
  47
  48 int unit_name_from_path(const char *path, const char *suffix, char **ret);
  49 int unit_name_from_path_instance(const char *prefix, const char *path, const char *suffix, char **ret);
  50 int unit_name_to_path(const char *name, char **ret);
  51
  52 typedef enum UnitNameMangle {
  53         UNIT_NAME_MANGLE_GLOB = 1 << 0,
  54         UNIT_NAME_MANGLE_WARN = 1 << 1,
  55 } UnitNameMangle;
  56
  57 int unit_name_mangle_with_suffix(const char *name, UnitNameMangle flags, const char *suffix, char **ret);
  58
  59 static inline int unit_name_mangle(const char *name, UnitNameMangle flags, char **ret) {
  60         return unit_name_mangle_with_suffix(name, flags, ".service", ret);
  61 }
  62
  63 int slice_build_parent_slice(const char *slice, char **ret);
  64 int slice_build_subslice(const char *slice, const char *name, char **subslice);
  65 bool slice_name_is_valid(const char *name);