Home | History | Annotate | Download | only in proto
      1 /*
      2  * Copyright (C) 2016 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 #ifndef AAPT_FORMAT_PROTO_PROTOSERIALIZE_H
     18 #define AAPT_FORMAT_PROTO_PROTOSERIALIZE_H
     19 
     20 #include "android-base/macros.h"
     21 #include "androidfw/ConfigDescription.h"
     22 
     23 #include "Configuration.pb.h"
     24 #include "ResourceTable.h"
     25 #include "ResourceValues.h"
     26 #include "Resources.pb.h"
     27 #include "ResourcesInternal.pb.h"
     28 #include "StringPool.h"
     29 #include "xml/XmlDom.h"
     30 
     31 namespace aapt {
     32 
     33 struct SerializeXmlOptions {
     34   /** Remove text nodes that only contain whitespace. */
     35   bool remove_empty_text_nodes = false;
     36 };
     37 
     38 // Serializes a Value to its protobuf representation. An optional StringPool will hold the
     39 // source path string.
     40 void SerializeValueToPb(const Value& value, pb::Value* out_value, StringPool* src_pool = nullptr);
     41 
     42 // Serialize an Item into its protobuf representation. pb::Item does not store the source path nor
     43 // comments of an Item.
     44 void SerializeItemToPb(const Item& item, pb::Item* out_item);
     45 
     46 // Serializes an XML element into its protobuf representation.
     47 void SerializeXmlToPb(const xml::Element& el, pb::XmlNode* out_node,
     48                       const SerializeXmlOptions options = {});
     49 
     50 // Serializes an XmlResource into its protobuf representation. The ResourceFile is NOT serialized.
     51 void SerializeXmlResourceToPb(const xml::XmlResource& resource, pb::XmlNode* out_node,
     52                               const SerializeXmlOptions options = {});
     53 
     54 // Serializes a StringPool into its protobuf representation, which is really just the binary
     55 // ResStringPool representation stuffed into a bytes field.
     56 void SerializeStringPoolToPb(const StringPool& pool, pb::StringPool* out_pb_pool, IDiagnostics* diag);
     57 
     58 // Serializes a ConfigDescription into its protobuf representation.
     59 void SerializeConfig(const android::ConfigDescription& config, pb::Configuration* out_pb_config);
     60 
     61 // Serializes a ResourceTable into its protobuf representation.
     62 void SerializeTableToPb(const ResourceTable& table, pb::ResourceTable* out_table, IDiagnostics* diag);
     63 
     64 // Serializes a ResourceFile into its protobuf representation.
     65 void SerializeCompiledFileToPb(const ResourceFile& file, pb::internal::CompiledFile* out_file);
     66 
     67 }  // namespace aapt
     68 
     69 #endif /* AAPT_FORMAT_PROTO_PROTOSERIALIZE_H */
     70