src/tools/gn/location.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef TOOLS_GN_LOCATION_H_
   6 #define TOOLS_GN_LOCATION_H_
   7
   8 #include <string>
   9
  10 class InputFile;
  11
  12 // Represents a place in a source file. Used for error reporting.
  13 class Location {
  14  public:
  15   Location();
  16   Location(const InputFile* file, int line_number, int char_offset);
  17
  18   const InputFile* file() const { return file_; }
  19   int line_number() const { return line_number_; }
  20   int char_offset() const { return char_offset_; }
  21
  22   bool operator==(const Location& other) const;
  23   bool operator!=(const Location& other) const;
  24   bool operator<(const Location& other) const;
  25
  26   // Returns a string with the file, line, and (optionally) the character
  27   // offset for this location. If this location is null, returns an empty
  28   // string.
  29   std::string Describe(bool include_char_offset) const;
  30
  31  private:
  32   const InputFile* file_;  // Null when unset.
  33   int line_number_;  // -1 when unset.
  34   int char_offset_;  // -1 when unset.
  35 };
  36
  37 // Represents a range in a source file. Used for error reporting.
  38 // The end is exclusive i.e. [begin, end)
  39 class LocationRange {
  40  public:
  41   LocationRange();
  42   LocationRange(const Location& begin, const Location& end);
  43
  44   const Location& begin() const { return begin_; }
  45   const Location& end() const { return end_; }
  46
  47   LocationRange Union(const LocationRange& other) const;
  48
  49  private:
  50   Location begin_;
  51   Location end_;
  52 };
  53
  54 #endif  // TOOLS_GN_LOCATION_H_