1    :  // Copyright 2012 Google Inc. All Rights Reserved.
   2    :  //
   3    :  // Licensed under the Apache License, Version 2.0 (the "License");
   4    :  // you may not use this file except in compliance with the License.
   5    :  // You may obtain a copy of the License at
   6    :  //
   7    :  //     http://www.apache.org/licenses/LICENSE-2.0
   8    :  //
   9    :  // Unless required by applicable law or agreed to in writing, software
  10    :  // distributed under the License is distributed on an "AS IS" BASIS,
  11    :  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12    :  // See the License for the specific language governing permissions and
  13    :  // limitations under the License.
  14    :  
  15    :  #ifndef SYZYGY_PDB_PDB_READER_H_
  16    :  #define SYZYGY_PDB_PDB_READER_H_
  17    :  
  18    :  #include <vector>
  19    :  
  20    :  #include "base/file_util.h"
  21    :  #include "base/files/file_path.h"
  22    :  #include "syzygy/pdb/pdb_constants.h"
  23    :  #include "syzygy/pdb/pdb_data.h"
  24    :  #include "syzygy/pdb/pdb_file.h"
  25    :  #include "syzygy/pdb/pdb_file_stream.h"
  26    :  #include "syzygy/pdb/pdb_stream.h"
  27    :  
  28    :  namespace pdb {
  29    :  
  30    :  // This class is used to read a PDB file from disk, populating a PdbFile
  31    :  // object with its streams.
  32    :  class PdbReader {
  33    :   public:
  34  E :    PdbReader() { }
  35    :  
  36    :    // Reads a PDB, populating the given PdbFile object with the streams.
  37    :    //
  38    :    // @note Once use of the above Read function variants has been eliminated,
  39    :    //     PdbReader will become stateless and simply populate a PdbFile.
  40    :    //
  41    :    // @param pdb_path the PDB file to read.
  42    :    // @param pdb_file the empty PdbFile object to be filled in.
  43    :    // @return true on success, false otherwise.
  44    :    bool Read(const base::FilePath& pdb_path, PdbFile* pdb_file);
  45    :  
  46    :   private:
  47    :    DISALLOW_COPY_AND_ASSIGN(PdbReader);
  48    :  };
  49    :  
  50    :  }  // namespace pdb
  51    :  
  52    :  #endif  // SYZYGY_PDB_PDB_READER_H_