/**
 * FreeRDP: A Remote Desktop Protocol Implementation
 * .rdp file
 *
 * Copyright 2012 Marc-Andre Moreau <marcandre.moreau@gmail.com>
 *
 * 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 FREERDP_CLIENT_RDP_FILE_H
#define FREERDP_CLIENT_RDP_FILE_H

#include <freerdp/api.h>
#include <freerdp/types.h>
#include <freerdp/settings.h>

/* Ignore invalid integer values */
#define RDP_FILE_FLAG_PARSE_INT_RELAXED 1

#ifdef __cplusplus
extern "C"
{
#endif

	typedef struct rdp_file rdpFile;
	typedef BOOL (*rdp_file_fkt_parse)(void* context, const char* key, char type,
	                                   const char* value);

	/* When using freerdp_client_parse_rdp_file_ex or freerdp_client_parse_rdp_file_buffer_ex
	 * set the context for the callback with this function. */
	FREERDP_API void freerdp_client_rdp_file_set_callback_context(rdpFile* file, void* context);

	WINPR_ATTR_NODISCARD
	FREERDP_API BOOL freerdp_client_parse_rdp_file(rdpFile* file, const char* name);

	WINPR_ATTR_NODISCARD
	FREERDP_API BOOL freerdp_client_parse_rdp_file_ex(rdpFile* file, const char* name,
	                                                  rdp_file_fkt_parse parse);

	WINPR_ATTR_NODISCARD
	FREERDP_API BOOL freerdp_client_parse_rdp_file_buffer(rdpFile* file, const BYTE* buffer,
	                                                      size_t size);

	WINPR_ATTR_NODISCARD
	FREERDP_API BOOL freerdp_client_parse_rdp_file_buffer_ex(rdpFile* file, const BYTE* buffer,
	                                                         size_t size, rdp_file_fkt_parse parse);

	/** @brief Populate \b settings from RDP \b file. Do only notify about inconsistencies and not
	 * correct them.
	 *
	 *  @param file A pointer to the RDP file to use
	 *  @param settings A pointer to the settings to update
	 *
	 *  @return \b TRUE for success, \b FALSE otherwise
	 *  @version since 3.17.0
	 */
	WINPR_ATTR_NODISCARD
	FREERDP_API BOOL freerdp_client_populate_settings_from_rdp_file_unchecked(
	    const rdpFile* file, rdpSettings* settings);

	/** @brief Populate \b settings from RDP \b file. Do correct inconsistencies detected.
	 *
	 *  @param file A pointer to the RDP file to use
	 *  @param settings A pointer to the settings to update
	 *
	 *  @return \b TRUE for success, \b FALSE otherwise
	 */
	WINPR_ATTR_NODISCARD
	FREERDP_API BOOL freerdp_client_populate_settings_from_rdp_file(const rdpFile* file,
	                                                                rdpSettings* settings);

	WINPR_ATTR_NODISCARD
	FREERDP_API BOOL freerdp_client_populate_rdp_file_from_settings(rdpFile* file,
	                                                                const rdpSettings* settings);

	WINPR_ATTR_NODISCARD
	FREERDP_API BOOL freerdp_client_write_rdp_file(const rdpFile* file, const char* name,
	                                               BOOL unicode);

	WINPR_ATTR_NODISCARD
	FREERDP_API size_t freerdp_client_write_rdp_file_buffer(const rdpFile* file, char* buffer,
	                                                        size_t size);

	WINPR_ATTR_NODISCARD
	FREERDP_API int freerdp_client_rdp_file_set_string_option(rdpFile* file, const char* name,
	                                                          const char* value);

	WINPR_ATTR_NODISCARD
	FREERDP_API const char* freerdp_client_rdp_file_get_string_option(const rdpFile* file,
	                                                                  const char* name);

	WINPR_ATTR_NODISCARD
	FREERDP_API int freerdp_client_rdp_file_set_integer_option(rdpFile* file, const char* name,
	                                                           int value);

	WINPR_ATTR_NODISCARD
	FREERDP_API int freerdp_client_rdp_file_get_integer_option(const rdpFile* file,
	                                                           const char* name);

	FREERDP_API void freerdp_client_rdp_file_free(rdpFile* file);

	WINPR_ATTR_MALLOC(freerdp_client_rdp_file_free, 1)
	FREERDP_API rdpFile* freerdp_client_rdp_file_new(void);

	WINPR_ATTR_MALLOC(freerdp_client_rdp_file_free, 1)
	FREERDP_API rdpFile* freerdp_client_rdp_file_new_ex(DWORD flags);

#ifdef __cplusplus
}
#endif

#endif /* FREERDP_CLIENT_RDP_FILE_H */
