Qbs

Blog Documentation Get Qbs Community
  • Qbs Manual
  • QbsModules
  • protobuf.objc
  • Qbs 2.4.0
  • protobuf.objc

    Provides support for protocol buffers for the Objective-C language. More...

    Since: Qbs 1.13

    Properties

    Detailed Description

    The protobuf.objc module provides support for generating Objective-C headers and sources from proto definition files using the protoc tool.

    Relevant File Tags

    TagAuto-tagged File NamesSinceDescription
    "protobuf.input"*.proto1.13.0Source files with this tag are considered inputs to the protoc compiler.
    "protobuf.hpp"1.18.0This tag is attached to the header files generated by protoc compiler.

    Property Documentation

    compilerName : string [since Qbs 1.17]

    The name of the protoc binary.

    Default: "protoc"

    This property was introduced in Qbs 1.17.


    compilerPath : string [since Qbs 1.17]

    The path to the protoc binary.

    Use this property to override the auto-detected location.

    Default: auto-detected

    This property was introduced in Qbs 1.17.


    frameworkPath : string

    The path where Protobuf.framework is located. Set this property to override the default location.

    Default: auto-detected


    importPaths : pathList

    The list of imports that are passed to the protoc tool via the --proto_path option. These imports should contain the proto files. They are used to determine the relative structure of the generated files.

    Note: The paths are passed to protoc in the same order as specified in this property and protoc output may differ depending on that order.

    Default: []


    includePath : string

    The path where protobuf Objective-C headers are located. Set this property to override the default location.

    Note: If frameworkPath is specified, this property has no effect.

    Default: auto-detected


    libraryPath : string

    Note: If frameworkPath is specified, this property has no effect.

    Default: auto-detected


    outputDir : string [read-only]

    The directory where the protoc compiler generated files are placed.

    The value of this property is automatically set by Qbs and cannot be changed by the user.