// Copyright 2012 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Central place to house common unittest functionality for pdb_lib.

#ifndef SYZYGY_PDB_UNITTEST_UTIL_H_
#define SYZYGY_PDB_UNITTEST_UTIL_H_

#include "base/files/file_util.h"
#include "syzygy/pdb/pdb_file.h"
#include "syzygy/pdb/pdb_file_stream.h"

namespace testing {

// Paths to various files.
extern const wchar_t kTestPdbFilePath[];
extern const wchar_t kTestDllFilePath[];
extern const wchar_t kOmappedTestPdbFilePath[];
extern const wchar_t kPdbStrPath[];
extern const wchar_t kValidPdbSymbolRecordStreamPath[];
extern const wchar_t kInvalidPdbSymbolRecordStreamPath[];
extern const wchar_t kValidPdbTypeInfoStreamPath[];
extern const wchar_t kInvalidHeaderPdbTypeInfoStreamPath[];
extern const wchar_t kInvalidDataPdbTypeInfoStreamPath[];
extern const wchar_t kValidPdbDbiStreamPath[];
extern const wchar_t kInvalidPdbDbiStreamPath[];

// Get a PDB stream from a file.
scoped_refptr<pdb::PdbFileStream> GetStreamFromFile(base::FilePath file_path);

// Initializes an empty PdbFile so that it looks like a valid PDB by creating
// a valid PdbHeaderInfo stream. Contains gtest assertions, so is intended to be
// used with ASSERT_NO_FATAL_FAILURE.
// @param pdb_file The empty PdbFile to be initialized.
void InitMockPdbFile(pdb::PdbFile* pdb_file);

}  // namespace testing

#endif  // SYZYGY_PDB_UNITTEST_UTIL_H_