guacamole-spice-protocol/src/protocols/rdp/plugins/ptr-string.h

64 lines
2.1 KiB
C

/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 GUAC_RDP_PLUGINS_PTR_STRING_H
#define GUAC_RDP_PLUGINS_PTR_STRING_H
#include "config.h"
#include <guacamole/client.h>
/**
* The maximum number of bytes required to represent a pointer printed using
* printf()'s "%p". This will be the size of the hex prefix ("0x"), null
* terminator, plus two bytes for every byte required by a pointer.
*/
#define GUAC_RDP_PTR_STRING_LENGTH (sizeof("0x") + (sizeof(void*) * 2))
/**
* Converts the given string back into a void pointer. The string MUST have
* been produced via guac_rdp_ptr_to_string().
*
* @param str
* The string to convert back to a pointer.
*
* @return
* The pointer value of the given string, as originally passed to
* guac_rdp_ptr_to_string().
*/
void* guac_rdp_string_to_ptr(const char* str);
/**
* Converts a void pointer into a string representation, safe for use with
* parts of the FreeRDP API which provide only for passing arbitrary strings,
* despite being within the same memory area.
*
* @param data
* The void pointer to convert to a string.
*
* @param str
* The buffer in which the string representation of the given void pointer
* should be stored. This buffer must have at least
* GUAC_RDP_PTR_STRING_LENGTH bytes available.
*/
void guac_rdp_ptr_to_string(void* data, char* str);
#endif