xref: /system/libvintf/include/vintf/parse_xml.h

/*
 * Copyright (C) 2017 The Android Open Source Project
 *
 * 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.
 */

#ifndef ANDROID_VINTF_PARSE_XML_H
#define ANDROID_VINTF_PARSE_XML_H

#include "CompatibilityMatrix.h"
#include "HalManifest.h"

namespace android {
namespace vintf {

enum SerializeFlag : uint32_t {
    NO_HALS = 1 << 0,
    NO_AVB = 1 << 1,
    NO_SEPOLICY = 1 << 2,
    NO_VNDK = 1 << 3,
    NO_KERNEL = 1 << 4,
    NO_XMLFILES = 1 << 5,
    NO_SSDK = 1 << 6,
    NO_FQNAME = 1 << 7,

    EVERYTHING = 0,
    HALS_ONLY = ~(NO_HALS | NO_FQNAME),  // <hal> with <fqname>
    XMLFILES_ONLY = ~NO_XMLFILES,
    SEPOLICY_ONLY = ~NO_SEPOLICY,
    VNDK_ONLY = ~NO_VNDK,
    HALS_NO_FQNAME = ~NO_HALS,  // <hal> without <fqname>
};
using SerializeFlags = uint32_t;

template<typename Object>
struct XmlConverter {
    XmlConverter() {}
    virtual ~XmlConverter() {}

    virtual const std::string &lastError() const = 0;

    // deprecated. Use operator() instead.
    virtual std::string serialize(const Object& o, SerializeFlags flags = EVERYTHING) const = 0;

    // Serialize an object to XML.
    virtual std::string operator()(const Object& o, SerializeFlags flags = EVERYTHING) const = 0;

    // deprecated. Use operator() instead. These APIs sets lastError(). Kept for testing.
    virtual bool deserialize(Object* o, const std::string& xml) = 0;
    virtual bool operator()(Object* o, const std::string& xml) = 0;

    // Deserialize an XML to object. Return whether it is successful. This API
    // does not touch lastError(), but instead sets error message
    // to optional "error" out parameter (which can be null).
    virtual bool operator()(Object* o, const std::string& xml, std::string* error) const = 0;
};

extern XmlConverter<HalManifest>& gHalManifestConverter;

extern XmlConverter<CompatibilityMatrix>& gCompatibilityMatrixConverter;

} // namespace vintf
} // namespace android

#endif // ANDROID_VINTF_PARSE_XML_H