path: root/rules/CC/RULES

{ "defaults":
  { "doc":
    [ "A rule to provide defaults."
    , "All CC targets take their defaults for CXX, CC, flags, etc from"
    , "the target [\"CC\", \"defaults\"]. This is probably the only sensibe"
    , "use of this rule. As targets form a different root, the defaults"
    , "can be provided without changing this directory."
    ]
  , "target_fields": ["base"]
  , "string_fields":
    [ "CC"
    , "CXX"
    , "CFLAGS"
    , "CXXFLAGS"
    , "ADD_CFLAGS"
    , "ADD_CXXFLAGS"
    , "PATH"
    , "AR"
    ]
  , "imports": {"base-provides": "defaults-base-provides"}
  , "expression":
    { "type": "let*"
    , "bindings":
      [ ["CC", {"type": "FIELD", "name": "CC"}]
      , ["CXX", {"type": "FIELD", "name": "CXX"}]
      , ["CFLAGS", {"type": "FIELD", "name": "CFLAGS"}]
      , ["CXXFLAGS", {"type": "FIELD", "name": "CXXFLAGS"}]
      , ["AR", {"type": "FIELD", "name": "AR"}]
      , ["PATH", {"type": "FIELD", "name": "PATH"}]
      , ["provider", "CC"]
      , [ "CC"
        , { "type": "if"
          , "cond": {"type": "var", "name": "CC"}
          , "then": {"type": "var", "name": "CC"}
          , "else": {"type": "CALL_EXPRESSION", "name": "base-provides"}
          }
        ]
      , ["provider", "CXX"]
      , [ "CXX"
        , { "type": "if"
          , "cond": {"type": "var", "name": "CXX"}
          , "then": {"type": "var", "name": "CXX"}
          , "else": {"type": "CALL_EXPRESSION", "name": "base-provides"}
          }
        ]
      , ["provider", "CFLAGS"]
      , [ "CFLAGS"
        , { "type": "if"
          , "cond": {"type": "var", "name": "CFLAGS"}
          , "then": {"type": "var", "name": "CFLAGS"}
          , "else": {"type": "CALL_EXPRESSION", "name": "base-provides"}
          }
        ]
      , ["provider", "CXXFLAGS"]
      , [ "CXXFLAGS"
        , { "type": "if"
          , "cond": {"type": "var", "name": "CXXFLAGS"}
          , "then": {"type": "var", "name": "CXXFLAGS"}
          , "else": {"type": "CALL_EXPRESSION", "name": "base-provides"}
          }
        ]
      , ["provider", "AR"]
      , [ "AR"
        , { "type": "if"
          , "cond": {"type": "var", "name": "AR"}
          , "then": {"type": "var", "name": "AR"}
          , "else": {"type": "CALL_EXPRESSION", "name": "base-provides"}
          }
        ]
      , ["provider", "ENV"]
      , [ "ENV"
        , { "type": "if"
          , "cond": {"type": "var", "name": "PATH"}
          , "then":
            { "type": "singleton_map"
            , "key": "PATH"
            , "value":
              { "type": "join"
              , "separator": ":"
              , "$1": {"type": "var", "name": "PATH"}
              }
            }
          , "else": {"type": "CALL_EXPRESSION", "name": "base-provides"}
          }
        ]
      , [ "CFLAGS"
        , { "type": "++"
          , "$1":
            [ {"type": "var", "name": "CFLAGS"}
            , {"type": "FIELD", "name": "ADD_CFLAGS"}
            ]
          }
        ]
      , [ "CXXFLAGS"
        , { "type": "++"
          , "$1":
            [ {"type": "var", "name": "CXXFLAGS"}
            , {"type": "FIELD", "name": "ADD_CXXFLAGS"}
            ]
          }
        ]
      ]
    , "body":
      { "type": "RESULT"
      , "provides":
        { "type": "env"
        , "vars": ["CC", "CXX", "CFLAGS", "CXXFLAGS", "AR", "ENV"]
        }
      }
    }
  }
, "header directory":
  { "doc":
    [ "A directory of header files."
    , ""
    , "Define a directory of  header files that belong together and are staged"
    , "in such a way that no other target (used together with this target) will"
    , "have to put files in this directory. The typical use case is a library"
    , "libfoo that expects all headers to be included as #include \"foo/bar.h\"."
    , "In this case, one would define a header direcotry for \"foo\"."
    , ""
    , "Technically, a tree is created from the given files and staged to the"
    , "specified location. Since trees are opaque, the directory name becomes"
    , "essentially owned by target. In this way, staging conflicts can be"
    , "avoided by detecting them early and not only once a file with the same"
    , "name is  added to the staging location. Also, as only a tree identifier"
    , "has to be passed around, such a directory can be handled more"
    , "efficiently by the tool."
    ]
  , "target_fields": ["hdrs"]
  , "string_fields": ["stage"]
  , "field_doc":
    { "hdrs": ["The header files to be put into the header directory."]
    , "stage":
      [ "The location of the header directory."
      , "Path segments are joined with \"/\"."
      ]
    }
  , "artifacts_doc": ["The single tree artifact staged to the given location"]
  , "runfiles_doc": ["Same as artifacts"]
  , "imports": {"runfiles": ["./", "..", "field_runfiles"]}
  , "expression":
    { "type": "let*"
    , "bindings":
      [ [ "hdrs"
        , { "type": "let*"
          , "bindings": [["fieldname", "hdrs"]]
          , "body": {"type": "CALL_EXPRESSION", "name": "runfiles"}
          }
        ]
      , [ "stage"
        , { "type": "join"
          , "separator": "/"
          , "$1": {"type": "FIELD", "name": "stage"}
          }
        ]
      , [ "dir"
        , { "type": "singleton_map"
          , "key": {"type": "var", "name": "stage"}
          , "value": {"type": "TREE", "$1": {"type": "var", "name": "hdrs"}}
          }
        ]
      ]
    , "body":
      { "type": "RESULT"
      , "artifacts": {"type": "var", "name": "dir"}
      , "runfiles": {"type": "var", "name": "dir"}
      }
    }
  }
, "library":
  { "doc": ["A C++ libaray"]
  , "target_fields": ["srcs", "hdrs", "private-hdrs", "deps", "proto"]
  , "string_fields":
    [ "name"
    , "stage"
    , "pure C"
    , "local defines"
    , "local cflags"
    , "link external"
    ]
  , "config_vars":
    [ "CXX"
    , "CC"
    , "CXXFLAGS"
    , "CFLAGS"
    , "ADD_CXXFLAGS"
    , "ADD_CFLAGS"
    , "ENV"
    , "AR"
    ]
  , "implicit": {"defaults": ["defaults"]}
  , "field_doc":
    { "name":
      ["The name of the library (without leading \"lib\" or trailing \".a\")."]
    , "srcs": ["The source files of the library."]
    , "hdrs": ["Any public header files of the library."]
    , "private-hdrs":
      [ "Any header files that only need to be present when compiling the"
      , "source files, but are not needed for any consumer of the library."
      ]
    , "stage":
      [ "The logical location of all header and source files, as well as the"
      , "resulting library file. Individual directory components are joined"
      , "with \"/\"."
      ]
    , "pure C":
      [ "If non-empty, compile as C sources rathter than C++ sources."
      , "In particular, CC is used to compile rather than CXX (or their"
      , "respective defaults)."
      ]
    , "local defines":
      [ "List of defines set for source files local to this target."
      , "Each list entry will be prepended by \"-D\"."
      ]
    , "local cflags":
      ["List of compile flags set for source files local to this target."]
    , "link external":
      [ "Additional linker flags for linking external libraries (not built"
      , "by this tool, typically system libraries)."
      ]
    , "deps": ["Any other libraries this library depends upon."]
    , "proto":
      [ "Any [\"proto\", \"library\"] this target depends upon directly."
      , "The creation of C++ bindings for this proto library as well as of"
      , "its dependencies will be taken care of (as anonymous targets, so no"
      , "duplicate work will be carried out, even if the same proto library"
      , "is used at various places)."
      ]
    }
  , "config_doc":
    { "CXX":
      [ "The name of the C++ compiler to be used."
      , "If None, the respective value from [\"CC\", \"defaults\"] will be taken."
      ]
    , "CC":
      [ "The name of the C compiler to be used (when compiling pure C code)."
      , "If None, the respective value from [\"CC\", \"defaults\"] will be taken."
      ]
    , "AR":
      [ "The archive tool to used for creating the library"
      , "If None, the respective value from [\"CC\", \"defaults\"] will be taken."
      ]
    , "ENV": ["The environment for any action generated."]
    , "CXXFLAGS":
      [ "The flags for CXX to be used instead of the default ones."
      , "For libraries that should be built in a non-standard way; usually"
      , "adapting the default target [\"CC\", \"defaults\"] is the better"
      , "choice."
      ]
    , "CFLAGS":
      [ "The flags for CC to be used instead of the default ones."
      , "For libraries that should be built in a non-standard way; usually"
      , "adapting the default target [\"CC\", \"defaults\"] is the better"
      , "choice"
      ]
    , "ADD_CXXFLAGS":
      [ "The flags to add to the default ones for CXX."
      , "For libraries that should be built in a non-standard way; usually"
      , "adapting the default target [\"CC\", \"defaults\"] is the better"
      , "choice."
      ]
    , "ADD_CFLAGS":
      [ "The flags to add to the default ones for CC."
      , "For libraries that should be built in a non-standard way; usually"
      , "adapting the default target [\"CC\", \"defaults\"] is the better"
      , "choice."
      ]
    }
  , "artifacts_doc":
    ["The actual library (libname.a) staged in the specified directory"]
  , "runfiles_doc": ["The public headers of this library"]
  , "provides_doc":
    { "compile-deps":
      [ "Map of artifacts specifying any additional files that, besides the runfiles,"
      , "have to be present in compile actions of targets depending on this library"
      ]
    , "link-deps":
      [ "Map of artifacts specifying any additional files that, besides the artifacts,"
      , "have to be present in a link actions of targets depending on this library"
      ]
    , "link-args":
      [ "List of strings that have to be added to the command line for linking actions"
      , "in targets depending on on this library"
      ]
    }
  , "anonymous":
    { "proto-deps":
      { "target": "proto"
      , "provider": "proto"
      , "rule_map":
        { "library": ["./", "proto", "library"]
        , "service library": ["./", "proto", "service library"]
        }
      }
    }
  , "imports":
    { "artifacts": ["./", "..", "field_artifacts"]
    , "default-CXXFLAGS": "default-CXXFLAGS"
    , "default-CFLAGS": "default-CFLAGS"
    , "result": "lib result"
    }
  , "expression":
    { "type": "let*"
    , "bindings":
      [ [ "local defines"
        , { "type": "foreach"
          , "var": "def"
          , "range": {"type": "FIELD", "name": "local defines"}
          , "body":
            {"type": "join", "$1": ["-D", {"type": "var", "name": "def"}]}
          }
        ]
      , ["local cflags", {"type": "FIELD", "name": "local cflags"}]
      , [ "CFLAGS"
        , { "type": "++"
          , "$1":
            [ { "type": "var"
              , "name": "CFLAGS"
              , "default":
                {"type": "CALL_EXPRESSION", "name": "default-CFLAGS"}
              }
            , {"type": "var", "name": "local defines"}
            ]
          }
        ]
      , [ "CXXFLAGS"
        , { "type": "++"
          , "$1":
            [ { "type": "var"
              , "name": "CXXFLAGS"
              , "default":
                {"type": "CALL_EXPRESSION", "name": "default-CXXFLAGS"}
              }
            , {"type": "var", "name": "local defines"}
            ]
          }
        ]
      , [ "stage"
        , { "type": "join"
          , "separator": "/"
          , "$1": {"type": "FIELD", "name": "stage"}
          }
        ]
      , [ "srcs"
        , { "type": "to_subdir"
          , "subdir": {"type": "var", "name": "stage"}
          , "$1":
            { "type": "let*"
            , "bindings": [["fieldname", "srcs"]]
            , "body": {"type": "CALL_EXPRESSION", "name": "artifacts"}
            }
          }
        ]
      , [ "hdrs"
        , { "type": "to_subdir"
          , "subdir": {"type": "var", "name": "stage"}
          , "$1":
            { "type": "let*"
            , "bindings": [["fieldname", "hdrs"]]
            , "body": {"type": "CALL_EXPRESSION", "name": "artifacts"}
            }
          }
        ]
      , [ "private-hdrs"
        , { "type": "to_subdir"
          , "subdir": {"type": "var", "name": "stage"}
          , "$1":
            { "type": "let*"
            , "bindings": [["fieldname", "private-hdrs"]]
            , "body": {"type": "CALL_EXPRESSION", "name": "artifacts"}
            }
          }
        ]
      , ["link external", {"type": "FIELD", "name": "link external"}]
      ]
    , "body": {"type": "CALL_EXPRESSION", "name": "result"}
    }
  }
, "binary":
  { "doc": ["A binary written in C++"]
  , "target_fields": ["srcs", "private-hdrs", "deps", "proto"]
  , "string_fields":
    ["name", "stage", "pure C", "local defines", "link external"]
  , "config_vars":
    ["CXX", "CC", "CXXFLAGS", "CFLAGS", "ADD_CXXFLAGS", "ADD_CFLAGS", "ENV"]
  , "implicit": {"defaults": ["defaults"]}
  , "field_doc":
    { "name": ["The name of the binary"]
    , "srcs": ["The source files of the library."]
    , "private-hdrs":
      [ "Any header files that need to be present when compiling the"
      , "source files."
      ]
    , "stage":
      [ "The logical location of all header and source files, as well as the"
      , "resulting binary file. Individual directory components are joined"
      , "with \"/\"."
      ]
    , "pure C":
      [ "If non-empty, compile as C sources rathter than C++ sources."
      , "In particular, CC is used to compile rather than CXX"
      ]
    , "local defines":
      [ "List of defines set for source files local to this target."
      , "Each list entry will be prepended by \"-D\"."
      ]
    , "link external":
      ["Additional linker flags for linking external libraries."]
    , "deps": ["Any other libraries this binary depends upon."]
    , "proto":
      [ "Any [\"proto\", \"library\"] this target depends upon directly."
      , "The creation of C++ bindings for this proto library as well as of"
      , "is dependencies will be taken care of (as anonymous targets, so no"
      , "duplicate work will be carried out, even if the same proto library"
      , "is used at various places)."
      ]
    }
  , "config_doc":
    { "CXX": ["The name of the C++ compiler to be used."]
    , "CC":
      ["The name of the C compiler to be used (when compiling pure C code)"]
    , "ENV": ["The environment for any action generated."]
    , "CXXFLAGS":
      [ "The flags for CXX to be used instead of the default ones"
      , "taken from the [\"CC\", \"defaults\"] target"
      ]
    , "CFLAGS":
      [ "The flags for CXX to be used instead of the default ones"
      , "taken from the [\"CC\", \"defaults\"] target"
      ]
    , "ADD_CXXFLAGS":
      [ "The flags to add to the default ones for CXX"
      , "taken from the [\"CC\", \"defaults\"] target"
      ]
    , "ADD_CFLAGS":
      [ "The flags to add to the default ones for CC"
      , "taken from the [\"CC\", \"defaults\"] target"
      ]
    }
  , "artifacts_doc": ["The final binary, staged to the given directory"]
  , "runfiles_doc": ["None"]
  , "anonymous":
    { "proto-deps":
      { "target": "proto"
      , "provider": "proto"
      , "rule_map":
        { "library": ["./", "proto", "library"]
        , "service library": ["./", "proto", "service library"]
        }
      }
    }
  , "imports":
    { "artifacts": ["./", "..", "field_artifacts"]
    , "compile-deps": "compile-deps"
    , "link-deps": "link-deps"
    , "link-args-deps": "link-args-deps"
    , "objects": "objects"
    , "compiler": "compiler"
    , "flags": "flags"
    , "default-ENV": "default-ENV"
    }
  , "expression":
    { "type": "let*"
    , "bindings":
      [ [ "local defines"
        , { "type": "foreach"
          , "var": "def"
          , "range": {"type": "FIELD", "name": "local defines"}
          , "body":
            {"type": "join", "$1": ["-D", {"type": "var", "name": "def"}]}
          }
        ]
      , [ "stage"
        , { "type": "join"
          , "separator": "/"
          , "$1": {"type": "FIELD", "name": "stage"}
          }
        ]
      , [ "srcs"
        , { "type": "to_subdir"
          , "subdir": {"type": "var", "name": "stage"}
          , "$1":
            { "type": "let*"
            , "bindings": [["fieldname", "srcs"]]
            , "body": {"type": "CALL_EXPRESSION", "name": "artifacts"}
            }
          }
        ]
      , [ "local hdrs"
        , { "type": "to_subdir"
          , "subdir": {"type": "var", "name": "stage"}
          , "$1":
            { "type": "let*"
            , "bindings": [["fieldname", "private-hdrs"]]
            , "body": {"type": "CALL_EXPRESSION", "name": "artifacts"}
            }
          }
        ]
      , ["CXX", {"type": "CALL_EXPRESSION", "name": "compiler"}]
      , ["CXXFLAGS", {"type": "CALL_EXPRESSION", "name": "flags"}]
      , [ "CXXFLAGS"
        , { "type": "++"
          , "$1":
            [ {"type": "var", "name": "CXXFLAGS"}
            , {"type": "var", "name": "local defines"}
            ]
          }
        ]
      , [ "ENV"
        , { "type": "map_union"
          , "$1":
            { "type": "++"
            , "$1":
              [ {"type": "CALL_EXPRESSION", "name": "default-ENV"}
              , [ { "type": "var"
                  , "name": "ENV"
                  , "default": {"type": "empty_map"}
                  }
                ]
              ]
            }
          }
        ]
      , ["deps-fieldnames", ["deps", "proto-deps"]]
      , ["compile-deps", {"type": "CALL_EXPRESSION", "name": "compile-deps"}]
      , ["link-deps", {"type": "CALL_EXPRESSION", "name": "link-deps"}]
      , ["objects", {"type": "CALL_EXPRESSION", "name": "objects"}]
      , [ "base name"
        , { "type": "assert_non_empty"
          , "msg": "A non-empty name has to be provided for binaries"
          , "$1": {"type": "join", "$1": {"type": "FIELD", "name": "name"}}
          }
        ]
      , [ "binary name"
        , { "type": "if"
          , "cond": {"type": "var", "name": "stage"}
          , "else": {"type": "var", "name": "base name"}
          , "then":
            { "type": "join"
            , "separator": "/"
            , "$1":
              [ {"type": "var", "name": "stage"}
              , {"type": "var", "name": "base name"}
              ]
            }
          }
        ]
      , [ "link-args"
        , { "type": "nub_right"
          , "$1":
            { "type": "++"
            , "$1":
              [ {"type": "keys", "$1": {"type": "var", "name": "objects"}}
              , {"type": "CALL_EXPRESSION", "name": "link-args-deps"}
              , {"type": "FIELD", "name": "link external"}
              ]
            }
          }
        ]
      , [ "binary"
        , { "type": "ACTION"
          , "outs": [{"type": "var", "name": "binary name"}]
          , "inputs":
            { "type": "disjoint_map_union"
            , "$1":
              [ {"type": "var", "name": "objects"}
              , {"type": "var", "name": "link-deps"}
              ]
            }
          , "cmd":
            { "type": "++"
            , "$1":
              [ [ {"type": "var", "name": "CXX"}
                , "-o"
                , {"type": "var", "name": "binary name"}
                ]
              , {"type": "var", "name": "CXXFLAGS"}
              , {"type": "var", "name": "link-args"}
              ]
            }
          , "env": {"type": "var", "name": "ENV"}
          }
        ]
      ]
    , "body":
      {"type": "RESULT", "artifacts": {"type": "var", "name": "binary"}}
    }
  }
}