src/basic/unit-name.h

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