Home | History | Annotate | Download | only in proto
      1 /*
      2  * Copyright 2015 Google Inc. 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 option java_package = "com.google.devtools.kythe.proto";
     21 
     22 // C++-specific details used in a CompilationUnit.
     23 // Its type is "kythe.io/proto/kythe.proto.CxxCompilationUnitDetails".
     24 message CxxCompilationUnitDetails {
     25   // A path used to search for compilation resources.
     26   message HeaderSearchDir {
     27     // The path to search in. If relative, is relative to working_directory.
     28     string path = 1;
     29     // The kind of data stored in this directory.
     30     // For C++, {0 = user code, 1 = system code, 2 = "extern C" system code}.
     31     int32 characteristic_kind = 2;
     32     // If true, this directory is a framework.
     33     bool is_framework = 3;
     34   }
     35 
     36   // Configuration for header search. This may be a function
     37   // of more state than is reflected in the environment and compiler
     38   // arguments.
     39   message HeaderSearchInfo {
     40     // For C-family languages, the index of the first directory to require <>s.
     41     int32 first_angled_dir = 1;
     42     // For C-family languages, the index of the first directory to have the
     43     // 'system_header' property.
     44     int32 first_system_dir = 2;
     45     // All search directories, ordered as {quoted, angled, system}.
     46     repeated HeaderSearchDir dir = 3;
     47   }
     48 
     49   HeaderSearchInfo header_search_info = 1;
     50 
     51   // Overrides the default assignment for the 'system_header' property for
     52   // C-family languages for both quoted and angled includes. The last matching
     53   // entry has effect.
     54   message SystemHeaderPrefix {
     55     // Matches if the include path has this string as a prefix.
     56     string prefix = 1;
     57     // Controls whether the matched path has the 'system_header' property.
     58     bool is_system_header = 2;
     59   }
     60 
     61   repeated SystemHeaderPrefix system_header_prefix = 2;
     62 }
     63