diff options
Diffstat (limited to 'SDL_Core/src/components/formatters/include/formatters/CFormatterJsonSDLRPCv1.hpp')
| -rw-r--r-- | SDL_Core/src/components/formatters/include/formatters/CFormatterJsonSDLRPCv1.hpp | 238 |
1 files changed, 0 insertions, 238 deletions
diff --git a/SDL_Core/src/components/formatters/include/formatters/CFormatterJsonSDLRPCv1.hpp b/SDL_Core/src/components/formatters/include/formatters/CFormatterJsonSDLRPCv1.hpp deleted file mode 100644 index 3b24a8a71..000000000 --- a/SDL_Core/src/components/formatters/include/formatters/CFormatterJsonSDLRPCv1.hpp +++ /dev/null @@ -1,238 +0,0 @@ -// Copyright (c) 2013, Ford Motor Company -// All rights reserved. -// -// Redistribution and use in source and binary forms, with or without -// modification, are permitted provided that the following conditions are met: -// -// Redistributions of source code must retain the above copyright notice, this -// list of conditions and the following disclaimer. -// -// Redistributions in binary form must reproduce the above copyright notice, -// this list of conditions and the following -// disclaimer in the documentation and/or other materials provided with the -// distribution. -// -// Neither the name of the Ford Motor Company nor the names of its contributors -// may be used to endorse or promote products derived from this software -// without specific prior written permission. -// -// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 'A PARTICULAR PURPOSE -// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE -// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE -// POSSIBILITY OF SUCH DAMAGE. -#ifndef __SMARTDEVICELINKCORE_JSONHANDLER_FORMATTERS__CFORMATTERJSONSDLRPCV1_HPP__ -#define __SMARTDEVICELINKCORE_JSONHANDLER_FORMATTERS__CFORMATTERJSONSDLRPCV1_HPP__ - -#include "json/json.h" - -#include "smart_objects/smart_object.h" -#include "smart_objects/enum_schema_item.h" - -#include "CFormatterJsonBase.hpp" - -#include "formatters/CSmartFactory.hpp" -#include "formatters/meta_formatter.h" - -namespace NsSmartDeviceLink { -namespace NsJSONHandler { -namespace Formatters { - -/** - * @brief Class is used to convert SmartObjects to JSON string and vice versa. - * - * JSON strings is in SDLRPCv1 format. - */ -class CFormatterJsonSDLRPCv1 : public CFormatterJsonBase { - private: - /** - * @brief Hidden constructor. - * - * The class contains only static methods. Should not be instantiated. - */ - CFormatterJsonSDLRPCv1(); - - /** - * @brief Hidden copy constructor. - * - * The class contains only static methods. Should not be instantiated. - */ - CFormatterJsonSDLRPCv1(const CFormatterJsonSDLRPCv1&); - - /** - * @brief Extracts a message type from the SmartObject - */ - static const std::string getMessageType( - const NsSmartDeviceLink::NsSmartObjects::SmartObject& obj); - - /** - * @brief Extracts a message type from the root JSON object. - * - * @return Type or empty string if there's no type in the JSON object. - */ - static const std::string getMessageType(const Json::Value& root); - - // SDLRPCv1 string consts - - /** - * @brief String constant for REQUEST. - */ - static const std::string S_REQUEST; - - /** - * @brief String constant for RESPONSE. - */ - static const std::string S_RESPONSE; - - /** - * @brief String constant for NOTIFICATION. - */ - static const std::string S_NOTIFICATION; - - /** - * @brief String constant for PARAMETERS. - */ - static const std::string S_PARAMETERS; - - /** - * @brief String constant for NAME. - */ - static const std::string S_NAME; - - /** - * @brief String constant for CORRELATION_ID. - */ - static const std::string S_CORRELATION_ID; - - public: - - static const int32_t kSuccess; - static const int32_t kParsingError; - static const int32_t kFunctionIdNotFound; - static const int32_t kMessageTypeNotFound; - static const int32_t kCorrelationIdNotFound; - - typedef NsSmartDeviceLink::NsJSONHandler::Formatters::meta_formatter_error_code::tMetaFormatterErrorCode tMetaFormatterErrorCode; - - /** - * @brief Creates a JSON string from a SmartObject. - * - * @param obj input SmartObject - * @param outStr resulting JSON string - * @return true if success, false otherwise - */ - static bool toString( - const NsSmartDeviceLink::NsSmartObjects::SmartObject &obj, - std::string& outStr); - - /** - * @brief Creates a SmartObject from a JSON string. - * - * @param str input JSON string - * @param out The resulting SmartObject - * @return true if success, otherwise - false - */ - template<typename FunctionId, typename MessageType> - static int32_t fromString(const std::string &str, - NsSmartDeviceLink::NsSmartObjects::SmartObject &out); - - /** - * @brief Converts to string the smart object against the given schema - * - * @param object Original smart object - * @param schema Smart schema which describes 'fake' smart object to be formatted - * @param outStr Resulting JSON string - * @return formatting error code - */ - static tMetaFormatterErrorCode MetaFormatToString( - const NsSmartDeviceLink::NsSmartObjects::SmartObject& object, - const NsSmartDeviceLink::NsSmartObjects::CSmartSchema& schema, - std::string& outStr); - -}; - -// ---------------------------------------------------------------------------- - -template<typename FunctionId, typename MessageType> -int32_t Formatters::CFormatterJsonSDLRPCv1::fromString( - const std::string& str, - NsSmartDeviceLink::NsSmartObjects::SmartObject& out) { - int32_t result = kSuccess; - - try { - Json::Value root; - Json::Reader reader; - std::string type; - - if (false == reader.parse(str, root)) { - result = kParsingError | kMessageTypeNotFound | kFunctionIdNotFound - | kCorrelationIdNotFound; - } - - if (kSuccess == result) { - type = getMessageType(root); - if (true == type.empty()) { - result = kMessageTypeNotFound | kFunctionIdNotFound - | kCorrelationIdNotFound; - } - } - - FunctionId functionId; - MessageType messageType; - - if (kSuccess == result) { - typedef NsSmartDeviceLink::NsSmartObjects::TEnumSchemaItem<MessageType> MessageTypeEnum; - if (false == MessageTypeEnum::stringToEnum(type, messageType)) { - // If MessageType is not found than FunctionId and CorrelationId can not be found either - result = kMessageTypeNotFound | kFunctionIdNotFound - | kCorrelationIdNotFound; - } - } - - if (kSuccess == result) { - typedef NsSmartDeviceLink::NsSmartObjects::TEnumSchemaItem<FunctionId> FunctionIdEnum; - if (false - == FunctionIdEnum::stringToEnum(root[type][S_NAME].asString(), - functionId)) { - result = kFunctionIdNotFound; - functionId = FunctionId::INVALID_ENUM; - } - } - - namespace S = NsSmartDeviceLink::NsJSONHandler::strings; - - if (!(result & kMessageTypeNotFound)) { - jsonValueToObj(root[type][S_PARAMETERS], out[S::S_MSG_PARAMS]); - - out[S::S_PARAMS][S::S_MESSAGE_TYPE] = messageType; - out[S::S_PARAMS][S::S_FUNCTION_ID] = functionId; - if (true == root[type][S_CORRELATION_ID].empty()) { - if (type != S_NOTIFICATION) { // Notification may not have CorrelationId - result |= kCorrelationIdNotFound; - out[S::S_PARAMS][S::S_CORRELATION_ID] = -1; - } - } else { - out[S::S_PARAMS][S::S_CORRELATION_ID] = root[type][S_CORRELATION_ID] - .asInt(); - } - out[S::S_PARAMS][S::S_PROTOCOL_TYPE] = 0; - out[S::S_PARAMS][S::S_PROTOCOL_VERSION] = 1; - } - } catch (...) { - result = kParsingError; - } - - return result; -} - -} -} -} // namespace NsSmartDeviceLink::NsJSONHandler::Formatters - -#endif // __SMARTDEVICELINKCORE_JSONHANDLER_FORMATTERS__CFORMATTERJSONSDLRPCV1_HPP__ |