VuoUrl

Description

Uniform Resource Locator.

Typedefs
typedef VuoText	VuoUrl
	Uniform Resource Locator.

Enumerations
enum	VuoUrlNormalizeFlags { VuoUrlNormalize_default = 0x0, VuoUrlNormalize_forSaving = 0x1, VuoUrlNormalize_assumeHttp = 0x2 }
	Bitwise flags modifying URL normalization behavior. More...

Functions
VuoUrl	VuoUrl_makeFromJson (struct json_object *js)
	Decodes the JSON object js, expected to contain a UTF-8 string, to create a new value.
struct json_object *	VuoUrl_getJson (const VuoUrl value)
	Encodes value as a JSON object.
char *	VuoUrl_getSummary (const VuoUrl value)
	Creates a new UTF-8 C string from value, or, if it's more than 50 Unicode characters long, creates an aposiopesis.
bool	VuoUrl_getParts (const VuoUrl url, VuoText *scheme, VuoText *user, VuoText *host, VuoInteger *port, VuoText *path, VuoText *query, VuoText *fragment)
	Attempts to parse url and outputs its parts.
bool	VuoUrl_getFileParts (const VuoUrl url, VuoText *path, VuoText *folder, VuoText *filename, VuoText *extension)
	Attempts to parse url as a file:/// URL, and outputs its parts.
bool	VuoUrl_areEqual (const VuoText a, const VuoText b)
	Returns true if a == b.
bool	VuoUrl_isLessThan (const VuoText a, const VuoText b)
	Returns true if a < b.
bool	VuoUrl_isRelativePath (const VuoUrl url)
	Returns a boolean indicating whether the provided url is a relative file path.
VuoUrl	VuoUrl_normalize (const VuoText url, enum VuoUrlNormalizeFlags flags)
	Resolves url (which could be an absolute URL, an absolute Unix file path, a relative Unix file path, or a user-relative Unix file path) into an absolute URL.
VuoText	VuoUrl_getPosixPath (const VuoUrl url)
	If url uses the file:// scheme, returns the corresponding (URL-decoded) POSIX path.
VuoText	VuoUrl_escapePosixPath (const VuoText posixPath)
	URL-escapes characters in path to make it a valid URL path.
bool	VuoUrl_isBundle (const VuoUrl url)
	Returns true if the url refers to an OS X bundle folder.
VuoUrl	VuoUrl_appendFileExtension (const char *filename, const char **validExtensions, const unsigned int extensionsLength)
	Given a filename and set of valid extensions, returns a new VuoUrl guaranteed to have the extension.
VuoText	VuoUrl_decodeRFC3986 (const VuoUrl url)
	Decodes a RFC 3986 section 2.1 URI-encoded string.
VuoUrl	VuoUrl_makeFromString (const char *str)
	Automatically generated function.
char *	VuoUrl_getString (const VuoUrl value)
	Automatically generated function.
void	VuoUrl_retain (VuoUrl value)
	Automatically generated function.
void	VuoUrl_release (VuoUrl value)
	Automatically generated function.

Typedef Documentation

typedef VuoText VuoUrl

Uniform Resource Locator.

Enumeration Type Documentation

enum VuoUrlNormalizeFlags

Bitwise flags modifying URL normalization behavior.

Enumerator
VuoUrlNormalize_default	Standard normalization (none of the below flags set).
VuoUrlNormalize_forSaving	For exported apps: if set, relative file paths will be resolved to Desktop instead of the app resources folder.
VuoUrlNormalize_assumeHttp	If the URL doesn't have an explicit scheme: if unset, the file scheme is added. If set, the http scheme is added.

Function Documentation

VuoUrl VuoUrl_appendFileExtension	(	const char *	filename,
		const char **	validExtensions,
		const unsigned int	extensionsLength
	)

Given a filename and set of valid extensions, returns a new VuoUrl guaranteed to have the extension.

bool VuoUrl_areEqual	(	const VuoText	a,
		const VuoText	b
	)

Returns true if a == b.

VuoText VuoUrl_decodeRFC3986

(

const VuoUrl

url

)

Decodes a RFC 3986 section 2.1 URI-encoded string.

For example, Hello%20world becomes Hello world.

VuoText VuoUrl_escapePosixPath

(

const VuoText

posixPath

)

URL-escapes characters in path to make it a valid URL path.

bool VuoUrl_getFileParts	(	const VuoUrl	url,
		VuoText *	path,
		VuoText *	folder,
		VuoText *	filename,
		VuoText *	extension
	)

Attempts to parse url as a file:/// URL, and outputs its parts.

Returns true if parsing succeeded (which implies all output parameters have been populated, though possibly with NULL or zero-length strings).

See Also

VuoFileUtilities::splitPath

struct json_object* VuoUrl_getJson ( const VuoUrl  value )

read

Encodes value as a JSON object.

bool VuoUrl_getParts	(	const VuoUrl	url,
		VuoText *	scheme,
		VuoText *	user,
		VuoText *	host,
		VuoInteger *	port,
		VuoText *	path,
		VuoText *	query,
		VuoText *	fragment
	)

Attempts to parse url and outputs its parts.

Returns true if parsing succeeded (which implies all output parameters have been populated, though possibly with NULL or zero-length strings).

VuoText VuoUrl_getPosixPath

(

const VuoUrl

url

)

If url uses the file:// scheme, returns the corresponding (URL-decoded) POSIX path.

If url does not use the file:// scheme, returns NULL.

char* VuoUrl_getString

(

const VuoUrl

value

)

Automatically generated function.

char* VuoUrl_getSummary

(

const VuoUrl

value

)

Creates a new UTF-8 C string from value, or, if it's more than 50 Unicode characters long, creates an aposiopesis.

bool VuoUrl_isBundle

(

const VuoUrl

url

)

Returns true if the url refers to an OS X bundle folder.

This function mirrors the behavior of Finder — .app bundles return true (in Finder, double-clicking launches the app); .framework bundles return false (in Finder, double-clicking opens the folder).

Returns false if the URL is non-local or is local but doesn't exist.

bool VuoUrl_isLessThan	(	const VuoText	a,
		const VuoText	b
	)

Returns true if a < b.

bool VuoUrl_isRelativePath

(

const VuoUrl

url

)

Returns a boolean indicating whether the provided url is a relative file path.

VuoUrl VuoUrl_makeFromJson

(

struct json_object *

js

)

Decodes the JSON object js, expected to contain a UTF-8 string, to create a new value.

VuoUrl VuoUrl_makeFromString

(

const char *

str

)

Automatically generated function.

VuoUrl VuoUrl_normalize	(	const VuoText	url,
		enum VuoUrlNormalizeFlags	flags
	)

Resolves url (which could be an absolute URL, an absolute Unix file path, a relative Unix file path, or a user-relative Unix file path) into an absolute URL.

If url contains a URL schema, this function assumes that all necessary characters are already URL-encoded. Otherwise, this function assumes that no characters in url are URL-encoded, and encodes the characters necessary to make it a valid URL.

If url is a Unix file path, and if all components of that path exist, this function attempts to resolve it into a canonical path by removing ".", "..", and extra slashes, and dereferencing symlinks.

If url is NULL, returns NULL.

If url is emptystring, returns a file URL for the current working path (or Desktop if VuoUrlNormalize_forSaving is set).

void VuoUrl_release

(

VuoUrl

value

)

Automatically generated function.

void VuoUrl_retain

(

VuoUrl

value

)

Automatically generated function.