blob: 84eec41b450678fd8fcf973e2694b88ddc1eab6e [file] [log] [blame]
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef BASE_FILE_VERSION_INFO_H__
#define BASE_FILE_VERSION_INFO_H__
#include "build/build_config.h"
#if defined(OS_WIN)
#include <windows.h>
// http://blogs.msdn.com/oldnewthing/archive/2004/10/25/247180.aspx
extern "C" IMAGE_DOS_HEADER __ImageBase;
#endif // OS_WIN
#include <string>
#include "base/base_export.h"
#include "base/string16.h"
class FilePath;
// Provides an interface for accessing the version information for a file. This
// is the information you access when you select a file in the Windows Explorer,
// right-click select Properties, then click the Version tab, and on the Mac
// when you select a file in the Finder and do a Get Info.
//
// This list of properties is straight out of Win32's VerQueryValue
// <http://msdn.microsoft.com/en-us/library/ms647464.aspx> and the Mac
// version returns values from the Info.plist as appropriate. TODO(avi): make
// this a less-obvious Windows-ism.
class FileVersionInfo {
public:
virtual ~FileVersionInfo() {}
#if defined(OS_WIN) || defined(OS_MACOSX)
// Creates a FileVersionInfo for the specified path. Returns NULL if something
// goes wrong (typically the file does not exit or cannot be opened). The
// returned object should be deleted when you are done with it.
BASE_EXPORT static FileVersionInfo* CreateFileVersionInfo(
const FilePath& file_path);
#endif // OS_WIN || OS_MACOSX
#if defined(OS_WIN)
// Creates a FileVersionInfo for the specified module. Returns NULL in case
// of error. The returned object should be deleted when you are done with it.
BASE_EXPORT static FileVersionInfo* CreateFileVersionInfoForModule(
HMODULE module);
// Creates a FileVersionInfo for the current module. Returns NULL in case
// of error. The returned object should be deleted when you are done with it.
// This function should be inlined so that the "current module" is evaluated
// correctly, instead of being the module that contains base.
__forceinline static FileVersionInfo*
CreateFileVersionInfoForCurrentModule() {
HMODULE module = reinterpret_cast<HMODULE>(&__ImageBase);
return CreateFileVersionInfoForModule(module);
}
#else
// Creates a FileVersionInfo for the current module. Returns NULL in case
// of error. The returned object should be deleted when you are done with it.
BASE_EXPORT static FileVersionInfo* CreateFileVersionInfoForCurrentModule();
#endif // OS_WIN
// Accessors to the different version properties.
// Returns an empty string if the property is not found.
virtual string16 company_name() = 0;
virtual string16 company_short_name() = 0;
virtual string16 product_name() = 0;
virtual string16 product_short_name() = 0;
virtual string16 internal_name() = 0;
virtual string16 product_version() = 0;
virtual string16 private_build() = 0;
virtual string16 special_build() = 0;
virtual string16 comments() = 0;
virtual string16 original_filename() = 0;
virtual string16 file_description() = 0;
virtual string16 file_version() = 0;
virtual string16 legal_copyright() = 0;
virtual string16 legal_trademarks() = 0;
virtual string16 last_change() = 0;
virtual bool is_official_build() = 0;
};
#endif // BASE_FILE_VERSION_INFO_H__