Panda3D
|
A container for a URL, e.g. More...
#include <pandadoc.hpp>
Public Member Functions | |
__init__ () | |
__init__ (const URLSpec url, const Filename path) | |
Creates a URLSpec by appending a path to the end of the old URLSpec, inserting an intervening forward slash if necessary. | |
__init__ (const URLSpec) | |
__init__ (str url, bool server_name_expected) | |
int | compareTo (const URLSpec other) |
Returns a number less than zero if this URLSpec sorts before the other one, greater than zero if it sorts after, or zero if they are equivalent. | |
str | cStr () |
bool | empty () |
Returns false if the URLSpec is valid (not empty), or true if it is an empty string. | |
str | getAuthority () |
Returns the authority specified by the URL (this includes username, server, and/or port), or empty string if no authority is specified. | |
int | getHash () |
str | getPath () |
Returns the path specified by the URL, or "/" if no path is specified. | |
str | getPathAndQuery () |
Returns the path (or "/" if no path is specified), followed by the query if it is specified. | |
uint16_t | getPort () |
Returns the port number specified by the URL, or the default port if not specified. | |
str | getPortStr () |
Returns the port specified by the URL as a string, or the empty string if no port is specified. | |
str | getQuery () |
Returns the query specified by the URL, or empty string if no query is specified. | |
str | getScheme () |
Returns the scheme specified by the URL, or empty string if no scheme is specified. | |
str | getServer () |
Returns the server name specified by the URL, if any. | |
str | getServerAndPort () |
Returns a string consisting of the server name, followed by a colon, followed by the port number. | |
str | getUrl () |
Returns the complete URL specification. | |
str | getUsername () |
Returns the username specified by the URL, if any. | |
bool | hasAuthority () |
Returns true if the URL specifies an authority (this includes username, server, and/or port), false otherwise. | |
bool | hasPath () |
Returns true if the URL includes a path specification (that is, the particular filename on the server to retrieve), false otherwise. | |
bool | hasPort () |
Returns true if the URL specifies a port number, false otherwise. | |
bool | hasQuery () |
Returns true if the URL includes a query specification, false otherwise. | |
bool | hasScheme () |
Returns true if the URL specifies a scheme (e.g. | |
bool | hasServer () |
Returns true if the URL specifies a server name, false otherwise. | |
bool | hasUsername () |
Returns true if the URL specifies a username (and/or password), false otherwise. | |
bool | input (Istream in) |
bool | isDefaultPort () |
Returns true if the port number encoded in this URL is the default port number for the scheme (or if there is no port number), or false if it is a nonstandard port. | |
bool | isSsl () |
Returns true if the URL's scheme specifies an SSL-secured protocol such as https, or false otherwise. | |
int | length () |
bool | operator!= (const URLSpec other) |
bool | operator< (const URLSpec other) |
URLSpec | operator= (str url) |
bool | operator== (const URLSpec other) |
char | operator[] (int n) |
output (Ostream out) | |
setAuthority (str authority) | |
Replaces the authority part of the URL specification. | |
setPath (str path) | |
Replaces the path part of the URL specification. | |
setPort (str port) | |
Replaces the port part of the URL specification. | |
setPort (uint16_t port) | |
Replaces the port part of the URL specification, given a numeric port number. | |
setQuery (str query) | |
Replaces the query part of the URL specification. | |
setScheme (str scheme) | |
Replaces the scheme part of the URL specification. | |
setServer (str server) | |
Replaces the server part of the URL specification. | |
setServerAndPort (str server_and_port) | |
Replaces the server and port parts of the URL specification simultaneously. | |
setUrl (str url, bool server_name_expected) | |
Completely replaces the URL with the indicated string. | |
setUsername (str username) | |
Replaces the username part of the URL specification. | |
int | size () |
Static Public Member Functions | |
static int | getDefaultPortForScheme (str scheme) |
Returns the default port number for the indicated scheme, or 0 if there is no known default. | |
static str | quote (str source, str safe) |
Returns the source string with all "unsafe" characters quoted, making a string suitable for placing in a URL. | |
static str | quotePlus (str source, str safe) |
Behaves like quote() with the additional behavior of replacing spaces with plus signs. | |
static str | unquote (str source) |
Reverses the operation of quote(): converts escaped characters of the form "%xx" to their ascii equivalent. | |
static str | unquotePlus (str source) |
Reverses the operation of quote_plus(): converts escaped characters of the form "%xx" to their ascii equivalent, and also converts plus signs to spaces. | |
Public Attributes | |
String | authority |
Returns the authority specified by the URL (this includes username, server, and/or port), or empty string if no authority is specified. | |
String | path |
Returns the path specified by the URL, or "/" if no path is specified. | |
uint16_t | port |
Returns the port number specified by the URL, or the default port if not specified. | |
String | query |
Returns the query specified by the URL, or empty string if no query is specified. | |
String | scheme |
Returns the scheme specified by the URL, or empty string if no scheme is specified. | |
String | server |
Returns the server name specified by the URL, if any. | |
String | server_and_port |
Returns a string consisting of the server name, followed by a colon, followed by the port number. | |
bool | ssl |
Returns true if the URL's scheme specifies an SSL-secured protocol such as https, or false otherwise. | |
String | username |
Returns the username specified by the URL, if any. | |
A container for a URL, e.g.
"http://server:port/path".
The URLSpec object is similar to a Filename in that it contains logic to identify the various parts of a URL and return (or modify) them separately.
__init__ | ( | ) |
__init__ | ( | const URLSpec | ) |
__init__ | ( | str | url, |
bool | server_name_expected ) |
int compareTo | ( | const URLSpec | other | ) |
Returns a number less than zero if this URLSpec sorts before the other one, greater than zero if it sorts after, or zero if they are equivalent.
str cStr | ( | ) |
bool empty | ( | ) |
Returns false if the URLSpec is valid (not empty), or true if it is an empty string.
str getAuthority | ( | ) |
Returns the authority specified by the URL (this includes username, server, and/or port), or empty string if no authority is specified.
|
static |
Returns the default port number for the indicated scheme, or 0 if there is no known default.
int getHash | ( | ) |
str getPath | ( | ) |
Returns the path specified by the URL, or "/" if no path is specified.
str getPathAndQuery | ( | ) |
Returns the path (or "/" if no path is specified), followed by the query if it is specified.
uint16_t getPort | ( | ) |
Returns the port number specified by the URL, or the default port if not specified.
str getPortStr | ( | ) |
Returns the port specified by the URL as a string, or the empty string if no port is specified.
Compare this with get_port(), which returns a default port number if no port is specified.
str getQuery | ( | ) |
Returns the query specified by the URL, or empty string if no query is specified.
str getScheme | ( | ) |
Returns the scheme specified by the URL, or empty string if no scheme is specified.
str getServer | ( | ) |
Returns the server name specified by the URL, if any.
In case of an IPv6 address, does not include the enclosing brackets.
str getServerAndPort | ( | ) |
Returns a string consisting of the server name, followed by a colon, followed by the port number.
If the port number is not explicitly given in the URL, this string will include the implicit port number. If the server is an IPv6 address, it will be enclosed in square brackets.
str getUrl | ( | ) |
Returns the complete URL specification.
str getUsername | ( | ) |
Returns the username specified by the URL, if any.
This might also include a password, e.g. "username:password", although putting a password on the URL is probably a bad idea.
bool hasAuthority | ( | ) |
Returns true if the URL specifies an authority (this includes username, server, and/or port), false otherwise.
bool hasPath | ( | ) |
Returns true if the URL includes a path specification (that is, the particular filename on the server to retrieve), false otherwise.
bool hasPort | ( | ) |
Returns true if the URL specifies a port number, false otherwise.
bool hasQuery | ( | ) |
Returns true if the URL includes a query specification, false otherwise.
bool hasScheme | ( | ) |
Returns true if the URL specifies a scheme (e.g.
"http:"), false otherwise.
bool hasServer | ( | ) |
Returns true if the URL specifies a server name, false otherwise.
bool hasUsername | ( | ) |
Returns true if the URL specifies a username (and/or password), false otherwise.
bool input | ( | Istream | in | ) |
bool isDefaultPort | ( | ) |
Returns true if the port number encoded in this URL is the default port number for the scheme (or if there is no port number), or false if it is a nonstandard port.
bool isSsl | ( | ) |
Returns true if the URL's scheme specifies an SSL-secured protocol such as https, or false otherwise.
int length | ( | ) |
bool operator!= | ( | const URLSpec | other | ) |
bool operator< | ( | const URLSpec | other | ) |
URLSpec operator= | ( | str | url | ) |
bool operator== | ( | const URLSpec | other | ) |
char operator[] | ( | int | n | ) |
output | ( | Ostream | out | ) |
|
static |
Returns the source string with all "unsafe" characters quoted, making a string suitable for placing in a URL.
Letters, digits, and the underscore, comma, period, and hyphen characters, as well as any included in the safe string, are left alone; all others are converted to hex representation.
|
static |
Behaves like quote() with the additional behavior of replacing spaces with plus signs.
setAuthority | ( | str | authority | ) |
Replaces the authority part of the URL specification.
This includes the username, server, and port.
setPath | ( | str | path | ) |
Replaces the path part of the URL specification.
setPort | ( | str | port | ) |
Replaces the port part of the URL specification.
setPort | ( | uint16_t | port | ) |
Replaces the port part of the URL specification, given a numeric port number.
setQuery | ( | str | query | ) |
Replaces the query part of the URL specification.
setScheme | ( | str | scheme | ) |
Replaces the scheme part of the URL specification.
setServer | ( | str | server | ) |
Replaces the server part of the URL specification.
Unlike set_server_and_port, this method does not require IPv6 addresses to be enclosed in square brackets.
setServerAndPort | ( | str | server_and_port | ) |
Replaces the server and port parts of the URL specification simultaneously.
The input string should be of the form "server:port", or just "server" to make the port number implicit. Any IPv6 address must be enclosed in square brackets.
setUrl | ( | str | url, |
bool | server_name_expected ) |
Completely replaces the URL with the indicated string.
If server_name_expected is true, it is a hint that an undecorated URL is probably a server name, not a local filename.
setUsername | ( | str | username | ) |
Replaces the username part of the URL specification.
int size | ( | ) |
|
static |
Reverses the operation of quote(): converts escaped characters of the form "%xx" to their ascii equivalent.
|
static |
Reverses the operation of quote_plus(): converts escaped characters of the form "%xx" to their ascii equivalent, and also converts plus signs to spaces.
String authority |
Returns the authority specified by the URL (this includes username, server, and/or port), or empty string if no authority is specified.
String path |
Returns the path specified by the URL, or "/" if no path is specified.
uint16_t port |
Returns the port number specified by the URL, or the default port if not specified.
String query |
Returns the query specified by the URL, or empty string if no query is specified.
String scheme |
Returns the scheme specified by the URL, or empty string if no scheme is specified.
String server |
Returns the server name specified by the URL, if any.
In case of an IPv6 address, does not include the enclosing brackets.
String server_and_port |
Returns a string consisting of the server name, followed by a colon, followed by the port number.
If the port number is not explicitly given in the URL, this string will include the implicit port number. If the server is an IPv6 address, it will be enclosed in square brackets.
bool ssl |
Returns true if the URL's scheme specifies an SSL-secured protocol such as https, or false otherwise.
String username |
Returns the username specified by the URL, if any.
This might also include a password, e.g. "username:password", although putting a password on the URL is probably a bad idea.