mars3142/wx_wherigo
1
0
Fork 0
Code Issues Pull Requests Wiki Activity

initial commit

Browse Source 
Signed-off-by: Peter Siegmund <mars3142@noreply.mars3142.dev>
This commit is contained in:
Peter Siegmund
2025-10-31 23:37:30 +01:00
commit bf6b52fd94
9654 changed files with 4035664 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

341
libs/wxWidgets-3.3.1/interface/wx/protocol/ftp.h Normal file
View File

@@ -0,0 +1,341 @@
/////////////////////////////////////////////////////////////////////////////
// Name: protocol/ftp.h
// Purpose: interface of wxFTP
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxFTP
wxFTP can be used to establish a connection to an FTP server and perform all the
usual operations. Please consult the RFC 959 (http://www.w3.org/Protocols/rfc959/)
for more details about the FTP protocol.
wxFTP can thus be used to create a (basic) FTP @b client.
To use a command which doesn't involve file transfer (i.e. directory oriented
commands) you just need to call a corresponding member function or use the
generic wxFTP::SendCommand() method.
However to actually transfer files you just get or give a stream to or from this
class and the actual data are read or written using the usual stream methods.
Example of using wxFTP for file downloading:
@code
wxFTP ftp;
// if you don't use these lines anonymous login will be used
ftp.SetUser("user");
ftp.SetPassword("password");
if ( !ftp.Connect("ftp.wxwidgets.org") )
{
wxLogError("Couldn't connect");
return;
}
ftp.ChDir("/pub/2.8.9");
const char *filename = "wxWidgets-2.8.9.tar.bz2";
int size = ftp.GetFileSize(filename);
if ( size == -1 )
{
wxLogError("Couldn't get the file size for \"%s\"", filename);
}
wxInputStream *in = ftp.GetInputStream(filename);
if ( !in )
{
wxLogError("Couldn't get the file");
}
else
{
char *data = new char[size];
if ( !in->Read(data, size) )
{
wxLogError("Read error: %d", ftp.GetError());
}
else
{
// file data is in the buffer
...
}
delete [] data;
delete in;
}
// gracefully close the connection to the server
ftp.Close();
@endcode
To upload a file you would do (assuming the connection to the server was opened
successfully):
@code
wxOutputStream *out = ftp.GetOutputStream("filename");
if ( out )
{
out->Write(...); // your data
delete out;
}
@endcode
@library{wxnet}
@category{net}
@see wxSocketBase
*/
class wxFTP : public wxProtocol
{
public:
/**
Transfer modes used by wxFTP.
*/
enum TransferMode
{
NONE, //!< not set by user explicitly.
ASCII,
BINARY
};
/**
Default constructor.
*/
wxFTP();
/**
Destructor will close the connection if connected.
*/
virtual ~wxFTP();
//@{
/**
Connect to the FTP server to default port (21) of the specified @a host.
*/
virtual bool Connect(const wxString& host);
/**
Connect to the FTP server to any port of the specified @a host.
By default (@a port = 0), connection is made to default FTP port (21)
of the specified @a host.
@since 2.9.1
*/
virtual bool Connect(const wxString& host, unsigned short port);
//@}
/**
@name Functions for managing the FTP connection
*/
//@{
/**
Aborts the download currently in process, returns @true if ok, @false
if an error occurred.
*/
virtual bool Abort();
/**
Gracefully closes the connection with the server.
*/
virtual bool Close();
/**
Send the specified @a command to the FTP server. @a ret specifies
the expected result.
@return @true if the command has been sent successfully, else @false.
*/
bool CheckCommand(const wxString& command, char ret);
/**
Returns the last command result, i.e. the full server reply for the last command.
*/
const wxString& GetLastResult();
/**
Send the specified @a command to the FTP server and return the first
character of the return code.
*/
char SendCommand(const wxString& command);
/**
Sets the transfer mode to ASCII. It will be used for the next transfer.
*/
bool SetAscii();
/**
Sets the transfer mode to binary. It will be used for the next transfer.
*/
bool SetBinary();
/**
If @a pasv is @true, passive connection to the FTP server is used.
This is the default as it works with practically all firewalls.
If the server doesn't support passive mode, you may call this function
with @false as argument to use an active connection.
*/
void SetPassive(bool pasv);
/**
Sets the password to be sent to the FTP server to be allowed to log in.
*/
virtual void SetPassword(const wxString& passwd);
/**
Sets the transfer mode to the specified one. It will be used for the next
transfer.
If this function is never called, binary transfer mode is used by default.
*/
bool SetTransferMode(TransferMode mode);
/**
Sets the user name to be sent to the FTP server to be allowed to log in.
*/
virtual void SetUser(const wxString& user);
//@}
/**
@name Filesystem commands
*/
//@{
/**
Change the current FTP working directory.
Returns @true if successful.
*/
bool ChDir(const wxString& dir);
/**
Create the specified directory in the current FTP working directory.
Returns @true if successful.
*/
bool MkDir(const wxString& dir);
/**
Returns the current FTP working directory.
*/
wxString Pwd();
/**
Rename the specified @a src element to @e dst. Returns @true if successful.
*/
bool Rename(const wxString& src, const wxString& dst);
/**
Remove the specified directory from the current FTP working directory.
Returns @true if successful.
*/
bool RmDir(const wxString& dir);
/**
Delete the file specified by @e path. Returns @true if successful.
*/
bool RmFile(const wxString& path);
/**
Returns @true if the given remote file exists, @false otherwise.
*/
bool FileExists(const wxString& filename);
/**
The GetList() function is quite low-level. It returns the list of the files in
the current directory. The list can be filtered using the @a wildcard string.
If @a wildcard is empty (default), it will return all files in directory.
The form of the list can change from one peer system to another. For example,
for a UNIX peer system, it will look like this:
@verbatim
-r--r--r-- 1 guilhem lavaux 12738 Jan 16 20:17 cmndata.cpp
-r--r--r-- 1 guilhem lavaux 10866 Jan 24 16:41 config.cpp
-rw-rw-rw- 1 guilhem lavaux 29967 Dec 21 19:17 cwlex_yy.c
-rw-rw-rw- 1 guilhem lavaux 14342 Jan 22 19:51 cwy_tab.c
-r--r--r-- 1 guilhem lavaux 13890 Jan 29 19:18 date.cpp
-r--r--r-- 1 guilhem lavaux 3989 Feb 8 19:18 datstrm.cpp
@endverbatim
But on Windows system, it will look like this:
@verbatim
winamp~1 exe 520196 02-25-1999 19:28 winamp204.exe
1 file(s) 520 196 bytes
@endverbatim
@return @true if the file list was successfully retrieved, @false otherwise.
@see GetFilesList()
*/
bool GetDirList(wxArrayString& files,
const wxString& wildcard = wxEmptyString);
/**
Returns the file size in bytes or -1 if the file doesn't exist or the size
couldn't be determined.
Notice that this size can be approximative size only and shouldn't be used
for allocating the buffer in which the remote file is copied, for example.
*/
int GetFileSize(const wxString& filename);
/**
This function returns the computer-parsable list of the files in the current
directory (optionally only of the files matching the @e wildcard, all files
by default).
This list always has the same format and contains one full (including the
directory path) file name per line.
@return @true if the file list was successfully retrieved, @false otherwise.
@see GetDirList()
*/
bool GetFilesList(wxArrayString& files,
const wxString& wildcard = wxEmptyString);
//@}
/**
@name Download and upload functions
*/
//@{
/**
Creates a new input stream on the specified path.
You can use all but the seek functionality of wxStreamBase.
wxStreamBase::Seek() isn't available on all streams. For example, HTTP or FTP
streams do not deal with it. Other functions like wxStreamBase::Tell() are
not available for this sort of stream, at present.
You will be notified when the EOF is reached by an error.
@return Returns @NULL if an error occurred (it could be a network failure
or the fact that the file doesn't exist).
*/
virtual wxInputStream* GetInputStream(const wxString& path);
/**
Initializes an output stream to the specified @a file.
The returned stream has all but the seek functionality of wxStreams.
When the user finishes writing data, he has to delete the stream to close it.
@return An initialized write-only stream.
Returns @NULL if an error occurred (it could be a network failure
or the fact that the file doesn't exist).
*/
virtual wxOutputStream* GetOutputStream(const wxString& file);
//@}
};

178
libs/wxWidgets-3.3.1/interface/wx/protocol/http.h Normal file
View File

@@ -0,0 +1,178 @@
/////////////////////////////////////////////////////////////////////////////
// Name: protocol/http.h
// Purpose: interface of wxHTTP
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxHTTP
wxHTTP can be used to establish a connection to an HTTP server.
wxHTTP can thus be used to create a (basic) HTTP @b client.
@note In practice, for any but the most trivial cases, e.g. if you need HTTPS, HTTP/2 or IPv6,
proxy detection, authentication, etc. support please use wxWebRequest instead.
@library{wxnet}
@category{net}
@see wxSocketBase, wxURL
*/
class wxHTTP : public wxProtocol
{
public:
/**
Default constructor.
*/
wxHTTP();
/**
Destructor will close the connection if connected.
*/
virtual ~wxHTTP();
//@{
/**
Connect to the HTTP server.
By default, connection is made to the port 80 of the specified @a host.
You may connect to a non-default port by specifying it explicitly using
the second overload.
Currently wxHTTP only supports IPv4.
For the overload taking wxSockAddress, the @a wait argument is ignored.
*/
virtual bool Connect(const wxString& host);
virtual bool Connect(const wxString& host, unsigned short port);
virtual bool Connect(const wxSockAddress& addr, bool wait);
//@}
/**
Returns the data attached with a field whose name is specified by @a header.
If the field doesn't exist, it will return an empty string and not a @NULL string.
@note
The header is not case-sensitive, i.e. "CONTENT-TYPE" and "content-type"
represent the same header.
*/
wxString GetHeader(const wxString& header) const;
/**
Creates a new input stream on the specified path.
Notice that this stream is unseekable, i.e. SeekI() and TellI() methods
shouldn't be used.
Note that you can still know the size of the file you are getting using
wxStreamBase::GetSize(). However there is a limitation: in HTTP protocol,
the size is not always specified so sometimes @c (size_t)-1 can returned to
indicate that the size is unknown.
In such case, you may want to use wxInputStream::LastRead() method in a loop
to get the total size.
@return Returns the initialized stream. You must delete it yourself
once you don't use it anymore and this must be done before
the wxHTTP object itself is destroyed. The destructor
closes the network connection. The next time you will
try to get a file the network connection will have to
be reestablished, but you don't have to take care of
this since wxHTTP reestablishes it automatically.
@see wxInputStream
*/
virtual wxInputStream* GetInputStream(const wxString& path);
/**
Returns the HTTP response code returned by the server.
Please refer to RFC 2616 for the list of responses.
*/
int GetResponse() const;
/**
Set HTTP method.
Set <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html">common</a>
or expanded HTTP method.
Overrides GET or POST methods that is used by default.
@param method
HTTP method name, e.g. "GET".
@since 3.0
@see SetPostBuffer(), SetPostText()
*/
void SetMethod(const wxString& method);
/**
It sets data of a field to be sent during the next request to the HTTP server.
The field name is specified by @a header and the content by @a h_data.
This is a low level function and it assumes that you know what you are doing.
*/
void SetHeader(const wxString& header, const wxString& h_data);
/**
Returns the value of a cookie.
*/
wxString GetCookie(const wxString& cookie) const;
/**
Returns @true if there were cookies.
*/
bool HasCookies() const;
/**
Set the binary data to be posted to the server.
If a non-empty buffer is passed to this method, the next request will
be an HTTP @c POST instead of the default HTTP @c GET and the given @a
data will be posted as the body of this request.
For textual data a more convenient SetPostText() can be used instead.
@param contentType
The value of HTTP "Content-Type" header, e.g. "image/png".
@param data
The data to post.
@return
@true if any data was passed in or @false if the buffer was empty.
@since 2.9.4
*/
bool SetPostBuffer(const wxString& contentType, const wxMemoryBuffer& data);
/**
Set the text to be posted to the server.
After a successful call to this method, the request will use HTTP @c
POST instead of the default @c GET when it's executed.
Use SetPostBuffer() if you need to post non-textual data.
@param contentType
The value of HTTP "Content-Type" header, e.g. "text/html;
charset=UTF-8".
@param data
The data to post.
@param conv
The conversion to use to convert @a data contents to a byte stream.
Its value should be consistent with the charset parameter specified
in @a contentType.
@return
@true if string was non-empty and was successfully converted using
the given @a conv or @false otherwise (in this case this request
won't be @c POST'ed correctly).
@since 2.9.4
*/
bool SetPostText(const wxString& contentType,
const wxString& data,
const wxMBConv& conv = wxConvUTF8);
};

60
libs/wxWidgets-3.3.1/interface/wx/protocol/log.h Normal file
View File

@@ -0,0 +1,60 @@
///////////////////////////////////////////////////////////////////////////////
// Name: wx/protocol/log.h
// Purpose: interface of wxProtocolLog
// Author: Vadim Zeitlin
// Created: 2009-03-06
// Copyright: (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
/**
Class allowing to log network operations performed by wxProtocol.
@library{wxnet}
@category{net}
@see wxProtocol
*/
class wxProtocolLog
{
public:
/**
Create object doing the logging using wxLogTrace() with the specified
trace mask.
If you override DoLogString() in your class the @a traceMask may be
left empty but it must have a valid value if you rely on the default
DoLogString() implementation.
*/
wxProtocolLog(const wxString& traceMask);
/**
Called by wxProtocol-derived objects to log strings sent to the server.
Default implementation prepends a client-to-server marker to @a str and
calls DoLogString().
*/
virtual void LogRequest(const wxString& str);
/**
Called by wxProtocol-derived objects to log strings received from the
server.
Default implementation prepends a server-to-client marker to @a str and
calls DoLogString().
*/
virtual void LogResponse(const wxString& str);
protected:
/**
Log the given string.
This function is called from LogRequest() and LogResponse() and by
default uses wxLogTrace() with the trace mask specified in the
constructor but can be overridden to do something different by the
derived classes.
*/
virtual void DoLogString(const wxString& str);
};

155
libs/wxWidgets-3.3.1/interface/wx/protocol/protocol.h Normal file
View File

@@ -0,0 +1,155 @@
/////////////////////////////////////////////////////////////////////////////
// Name: wx/protocol/protocol.h
// Purpose: interface of wxProtocol
// Author: wxWidgets team
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
Error values returned by wxProtocol.
*/
enum wxProtocolError
{
wxPROTO_NOERR = 0, //!< No error.
wxPROTO_NETERR, //!< A generic network error occurred.
wxPROTO_PROTERR, //!< An error occurred during negotiation.
wxPROTO_CONNERR, //!< The client failed to connect the server.
wxPROTO_INVVAL, //!< Invalid value.
wxPROTO_NOHNDLR, //!< Not currently used.
wxPROTO_NOFILE, //!< The remote file doesn't exist.
wxPROTO_ABRT, //!< Last action aborted.
wxPROTO_RCNCT, //!< An error occurred during reconnection.
wxPROTO_STREAMING //!< Someone tried to send a command during a transfer.
};
/**
@class wxProtocol
Represents a protocol for use with wxURL.
Note that you may want to change the default time-out for HTTP/FTP connections
and network operations (using SetDefaultTimeout()) since the default time-out
value is quite long (60 seconds).
@library{wxnet}
@category{net}
@see wxSocketBase, wxURL
*/
class wxProtocol : public wxSocketClient
{
public:
/**
Abort the current stream.
@warning
It is advised to destroy the input stream instead of aborting the stream
this way.
@return Returns @true, if successful, else @false.
*/
virtual bool Abort() = 0;
/**
Returns the type of the content of the last opened stream. It is a mime-type.
May be an empty string if the content-type is unknown.
*/
virtual wxString GetContentType() const;
/**
Returns the last occurred error.
@see wxProtocolError
*/
virtual wxProtocolError GetError() const;
/**
Creates a new input stream on the specified path.
You can use all but seek() functionality of wxStream.
Seek() isn't available on all streams. For example, HTTP or FTP streams
don't deal with it. Other functions like StreamSize() and Tell() aren't
available for the moment for this sort of stream.
You will be notified when the EOF is reached by an error.
@return Returns the initialized stream. You will have to delete it
yourself once you don't use it anymore. The destructor
closes the network connection.
@see wxInputStream
*/
virtual wxInputStream* GetInputStream(const wxString& path) = 0;
/**
Tries to reestablish a previous opened connection (close and renegotiate
connection).
@return @true, if the connection is established, else @false.
*/
bool Reconnect();
/**
Sets the authentication password.
*/
virtual void SetPassword(const wxString& user);
/**
Sets the authentication user.
*/
virtual void SetUser(const wxString& user);
/**
Sets a new default timeout for the network operations.
The default timeout is 60 seconds.
@see wxSocketBase::SetTimeout
*/
void SetDefaultTimeout(wxUint32 Value);
/**
@name Logging support.
Each wxProtocol object may have the associated logger (by default there
is none) which is used to log network requests and responses.
@see wxProtocolLog
*/
//@{
/**
Set the logger, deleting the old one and taking ownership of this one.
@param log
New logger allocated on the heap or @NULL.
*/
void SetLog(wxProtocolLog *log);
/**
Return the current logger, may be @NULL.
*/
wxProtocolLog *GetLog() const { return m_log; }
/**
Detach the existing logger without deleting it.
The caller is responsible for deleting the returned pointer if it's
non-null.
*/
wxProtocolLog *DetachLog();
/**
Call wxProtocolLog::LogRequest() if we have a valid logger or do
nothing otherwise.
*/
void LogRequest(const wxString& str);
/**
Call wxProtocolLog::LogResponse() if we have a valid logger or do
nothing otherwise.
*/
void LogResponse(const wxString& str);
//@}
};