kythe.io@v0.0.68-0.20240422202219-7225dbc01741/kythe/proto/cxx.proto (about)

     1  /*
     2   * Copyright 2015 The Kythe Authors. All rights reserved.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *   http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  syntax = "proto3";
    18  
    19  package kythe.proto;
    20  
    21  option go_package = "kythe.io/kythe/proto/cxx_go_proto";
    22  option java_package = "com.google.devtools.kythe.proto";
    23  
    24  // C++-specific details used in a CompilationUnit.
    25  // Its type is "kythe.io/proto/kythe.proto.CxxCompilationUnitDetails".
    26  message CxxCompilationUnitDetails {
    27    // A path used to search for compilation resources.
    28    message HeaderSearchDir {
    29      // The path to search in. If relative, is relative to working_directory.
    30      string path = 1;
    31      // The kind of data stored in this directory.
    32      // For C++, {0 = user code, 1 = system code, 2 = "extern C" system code}.
    33      int32 characteristic_kind = 2;
    34      // If true, this directory is a framework.
    35      bool is_framework = 3;
    36    }
    37  
    38    // Configuration for header search. This may be a function
    39    // of more state than is reflected in the environment and compiler
    40    // arguments.
    41    message HeaderSearchInfo {
    42      // For C-family languages, the index of the first directory to require <>s.
    43      int32 first_angled_dir = 1;
    44      // For C-family languages, the index of the first directory to have the
    45      // 'system_header' property.
    46      int32 first_system_dir = 2;
    47      // All search directories, ordered as {quoted, angled, system}.
    48      repeated HeaderSearchDir dir = 3;
    49    }
    50  
    51    HeaderSearchInfo header_search_info = 1;
    52  
    53    // Overrides the default assignment for the 'system_header' property for
    54    // C-family languages for both quoted and angled includes. The last matching
    55    // entry has effect.
    56    message SystemHeaderPrefix {
    57      // Matches if the include path has this string as a prefix.
    58      string prefix = 1;
    59      // Controls whether the matched path has the 'system_header' property.
    60      bool is_system_header = 2;
    61    }
    62  
    63    repeated SystemHeaderPrefix system_header_prefix = 2;
    64  
    65    // Adds an additional path to the indexer's virtual file system that
    66    // has no content (or has zero-length content).
    67    message StatPath {
    68      // The path to add. Assumed to be a directory.
    69      string path = 1;
    70    }
    71  
    72    repeated StatPath stat_path = 3;
    73  }