Chromium Embedded Framework (CEF)  130.1.2+g48f3ef6+chromium-130.0.6723.44
cef_parser.h File Reference
#include <vector>
#include "include/cef_base.h"
#include "include/cef_values.h"

Functions

bool CefResolveURL (const CefString &base_url, const CefString &relative_url, CefString &resolved_url)
 Combines specified |base_url| and |relative_url| into |resolved_url|. More...
 
bool CefParseURL (const CefString &url, CefURLParts &parts)
 Parse the specified |url| into its component parts. More...
 
bool CefCreateURL (const CefURLParts &parts, CefString &url)
 Creates a URL from the specified |parts|, which must contain a non-empty spec or a non-empty host and path (at a minimum), but not both. More...
 
CefString CefFormatUrlForSecurityDisplay (const CefString &origin_url)
 This is a convenience function for formatting a URL in a concise and human- friendly way to help users make security-related decisions (or in other circumstances when people need to distinguish sites, origins, or otherwise- simplified URLs from each other). More...
 
CefString CefGetMimeType (const CefString &extension)
 Returns the mime type for the specified file extension or an empty string if unknown. More...
 
void CefGetExtensionsForMimeType (const CefString &mime_type, std::vector< CefString > &extensions)
 Get the extensions associated with the given mime type. More...
 
CefString CefBase64Encode (const void *data, size_t data_size)
 Encodes |data| as a base64 string. More...
 
CefRefPtr< CefBinaryValueCefBase64Decode (const CefString &data)
 Decodes the base64 encoded string |data|. More...
 
CefString CefURIEncode (const CefString &text, bool use_plus)
 Escapes characters in |text| which are unsuitable for use as a query parameter value. More...
 
CefString CefURIDecode (const CefString &text, bool convert_to_utf8, cef_uri_unescape_rule_t unescape_rule)
 Unescapes |text| and returns the result. More...
 
CefRefPtr< CefValueCefParseJSON (const CefString &json_string, cef_json_parser_options_t options)
 Parses the specified |json_string| and returns a dictionary or list representation. More...
 
CefRefPtr< CefValueCefParseJSON (const void *json, size_t json_size, cef_json_parser_options_t options)
 Parses the specified UTF8-encoded |json| buffer of size |json_size| and returns a dictionary or list representation. More...
 
CefRefPtr< CefValueCefParseJSONAndReturnError (const CefString &json_string, cef_json_parser_options_t options, CefString &error_msg_out)
 Parses the specified |json_string| and returns a dictionary or list representation. More...
 
CefString CefWriteJSON (CefRefPtr< CefValue > node, cef_json_writer_options_t options)
 Generates a JSON string from the specified root |node| which should be a dictionary or list value. More...
 

Function Documentation

◆ CefBase64Decode()

CefRefPtr<CefBinaryValue> CefBase64Decode ( const CefString data)

Decodes the base64 encoded string |data|.

The returned value will be NULL if the decoding fails.

◆ CefBase64Encode()

CefString CefBase64Encode ( const void *  data,
size_t  data_size 
)

Encodes |data| as a base64 string.

◆ CefCreateURL()

bool CefCreateURL ( const CefURLParts parts,
CefString url 
)

Creates a URL from the specified |parts|, which must contain a non-empty spec or a non-empty host and path (at a minimum), but not both.

Returns false if |parts| isn't initialized as described.

◆ CefFormatUrlForSecurityDisplay()

CefString CefFormatUrlForSecurityDisplay ( const CefString origin_url)

This is a convenience function for formatting a URL in a concise and human- friendly way to help users make security-related decisions (or in other circumstances when people need to distinguish sites, origins, or otherwise- simplified URLs from each other).

Internationalized domain names (IDN) may be presented in Unicode if the conversion is considered safe. The returned value will (a) omit the path for standard schemes, excepting file and filesystem, and (b) omit the port if it is the default for the scheme. Do not use this for URLs which will be parsed or sent to other applications.

◆ CefGetExtensionsForMimeType()

void CefGetExtensionsForMimeType ( const CefString mime_type,
std::vector< CefString > &  extensions 
)

Get the extensions associated with the given mime type.

This should be passed in lower case. There could be multiple extensions for a given mime type, like "html,htm" for "text/html", or "txt,text,html,..." for "text/*". Any existing elements in the provided vector will not be erased.

◆ CefGetMimeType()

CefString CefGetMimeType ( const CefString extension)

Returns the mime type for the specified file extension or an empty string if unknown.

◆ CefParseJSON() [1/2]

CefRefPtr<CefValue> CefParseJSON ( const CefString json_string,
cef_json_parser_options_t  options 
)

Parses the specified |json_string| and returns a dictionary or list representation.

If JSON parsing fails this method returns NULL.

◆ CefParseJSON() [2/2]

CefRefPtr<CefValue> CefParseJSON ( const void *  json,
size_t  json_size,
cef_json_parser_options_t  options 
)

Parses the specified UTF8-encoded |json| buffer of size |json_size| and returns a dictionary or list representation.

If JSON parsing fails this method returns NULL.

◆ CefParseJSONAndReturnError()

CefRefPtr<CefValue> CefParseJSONAndReturnError ( const CefString json_string,
cef_json_parser_options_t  options,
CefString error_msg_out 
)

Parses the specified |json_string| and returns a dictionary or list representation.

If JSON parsing fails this method returns NULL and populates |error_msg_out| with a formatted error message.

◆ CefParseURL()

bool CefParseURL ( const CefString url,
CefURLParts parts 
)

Parse the specified |url| into its component parts.

Returns false if the URL is empty or invalid.

◆ CefResolveURL()

bool CefResolveURL ( const CefString base_url,
const CefString relative_url,
CefString resolved_url 
)

Combines specified |base_url| and |relative_url| into |resolved_url|.

Returns false if one of the URLs is empty or invalid.

◆ CefURIDecode()

CefString CefURIDecode ( const CefString text,
bool  convert_to_utf8,
cef_uri_unescape_rule_t  unescape_rule 
)

Unescapes |text| and returns the result.

Unescaping consists of looking for the exact pattern "%XX" where each X is a hex digit and converting to the character with the numerical value of those digits (e.g. "i%20=%203%3b" unescapes to "i = 3;"). If |convert_to_utf8| is true this function will attempt to interpret the initial decoded result as UTF-8. If the result is convertable into UTF-8 it will be returned as converted. Otherwise the initial decoded result will be returned. The |unescape_rule| parameter supports further customization the decoding process.

◆ CefURIEncode()

CefString CefURIEncode ( const CefString text,
bool  use_plus 
)

Escapes characters in |text| which are unsuitable for use as a query parameter value.

Everything except alphanumerics and -_.!~*'() will be converted to "%XX". If |use_plus| is true spaces will change to "+". The result is basically the same as encodeURIComponent in Javacript.

◆ CefWriteJSON()

CefString CefWriteJSON ( CefRefPtr< CefValue node,
cef_json_writer_options_t  options 
)

Generates a JSON string from the specified root |node| which should be a dictionary or list value.

Returns an empty string on failure. This method requires exclusive access to |node| including any underlying data.