version: "0.4.2"
classes:
  - name: "FileTarget"
    doc: >
      A target allowing logs to be written to a given file. Files are created
      as needed, and logs are appended to any existing contents.

      Events logged to the file will be separated by a newline character.
    namespace: "stumpless"
    constants:
      - name: "DEFAULT_FILE"
        type: "char *"
        value: "STUMPLESS_DEFAULT_FILE"
        includes: "stumpless/target.h"
    equivalent-struct:
      name: "stumpless_target"
      includes: "stumpless/target.h"
    constructors:
      - doc: >
          Creates a new file target with the given options and default facility
          code which will log messages to the given filename.

          Note that this will open the specified file, and it will remain open
          while this target is open. If you need to control the stream yourself,
          then you should use a StreamTarget instead.
        wrapped-function:
          name: "stumpless_open_file_target"
          includes: "stumpless/target/file.h"
          params:
            - name: "filename"
              doc: >
                The path to the file to write logs to.
              type: "const char *"
          return:
            type: "equivalent-struct-pointer"
          use-template: "pointer-return-error-check"
    destructor:
      doc: >
        Closes this target and releases all memory and other resources held by
        it.
      wrapped-function:
        name: "stumpless_close_file_target"
        includes: "stumpless/target/file.h"
        params:
          - name: "equivalent-struct-pointer"
    functions:
      - use-template: "common-target-functions"