blob: ee61a0aac96d331018c6e8bc17f726300f189ff2 [file] [log] [blame]
// Copyright (c) 2012 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.
// DataPack represents a read-only view onto an on-disk file that contains
// (key, value) pairs of data. It's used to store static resources like
// translation strings and images.
#include <stddef.h>
#include <stdint.h>
#include <map>
#include <memory>
#include <vector>
#include "base/files/file.h"
#include "base/files/memory_mapped_file.h"
#include "base/macros.h"
#include "base/strings/string_piece.h"
#include "ui/base/resource/data_pack_export.h"
#include "ui/base/resource/resource_handle.h"
namespace base {
class FilePath;
class RefCountedStaticMemory;
namespace ui {
enum ScaleFactor : int;
class UI_DATA_PACK_EXPORT DataPack : public ResourceHandle {
explicit DataPack(ui::ScaleFactor scale_factor);
~DataPack() override;
// Load a pack file from |path|, returning false on error. If the final
// extension of |path| is .gz, the file will be uncompressed and stored in
// memory owned by |data_source_|. Otherwise the file will be mapped to
// memory, with the mapping owned by |data_source_|.
bool LoadFromPath(const base::FilePath& path);
// Invokes LoadFromFileRegion with the entire contents of |file|. Compressed
// files are not supported.
bool LoadFromFile(base::File file);
// Loads a pack file from |region| of |file|, returning false on error.
// The file region will be mapped to memory with the mapping owned by
// |data_source_|.
bool LoadFromFileRegion(base::File file,
const base::MemoryMappedFile::Region& region);
// Loads a pack file from |buffer|, returning false on error.
// Data is not copied, |buffer| should stay alive during |DataPack| lifetime.
bool LoadFromBuffer(base::StringPiece buffer);
// Writes a pack file containing |resources| to |path|. If there are any
// text resources to be written, their encoding must already agree to the
// |textEncodingType| specified. If no text resources are present, please
// indicate BINARY.
static bool WritePack(const base::FilePath& path,
const std::map<uint16_t, base::StringPiece>& resources,
TextEncodingType textEncodingType);
// ResourceHandle implementation:
bool HasResource(uint16_t resource_id) const override;
bool GetStringPiece(uint16_t resource_id,
base::StringPiece* data) const override;
base::RefCountedStaticMemory* GetStaticMemory(
uint16_t resource_id) const override;
TextEncodingType GetTextEncodingType() const override;
ui::ScaleFactor GetScaleFactor() const override;
// Checks to see if any resource in this DataPack already exists in the list
// of resources.
void CheckForDuplicateResources(
const std::vector<std::unique_ptr<ResourceHandle>>& packs);
// Return the size of the resource and alias tables. Should only be used for
// unit-testing (more specifically checking that alias table generation
// removes entries for the resources table), as this is an implementation
// detail.
size_t GetResourceTableSizeForTesting() const { return resource_count_; }
size_t GetAliasTableSizeForTesting() const { return alias_count_; }
struct Entry;
struct Alias;
class DataSource;
class BufferDataSource;
class MemoryMappedDataSource;
class StringDataSource;
// Does the actual loading of a pack file.
// Called by Load and LoadFromFile and LoadFromBuffer.
bool LoadImpl(std::unique_ptr<DataSource> data_source);
const Entry* LookupEntryById(uint16_t resource_id) const;
std::unique_ptr<DataSource> data_source_;
const Entry* resource_table_;
size_t resource_count_;
const Alias* alias_table_;
size_t alias_count_;
// Type of encoding for text resources.
TextEncodingType text_encoding_type_;
// The scale of the image in this resource pack relative to images in the 1x
// resource pak.
ui::ScaleFactor scale_factor_;
} // namespace ui