annotate src/uicommon/gftpui.h @ 356:7cb3327f96f7

2003-1-5 Brian Masney <[e-mail]> * lib/gftp.h lib/misc.c src/gtk/gftpui.c - added GFTP_URL_USAGE that is the sytax for a valid URL. * lib/protocols.c (gftp_set_password) - allow the password to be NULL * src/gtk/gtkui.c src/text/textui.c src/uicommon/gftpui.h - added gftpui_prompt_username() and gftpui_promot_password() to each UI * src/text/gftp-text.c (gftp_text_ask_question) - don't display a : at the end of the question here. * src/text/gftp-text.h - added declaration of gftp_text_ask_question() * src/uicommon/gftpui.c - added gftpui_common_cmd_open(). This still needs a little bit more work done to it.

/*****************************************************************************/
/*  gftpui.h - UI related functions for gFTP                                 */
/*  Copyright (C) 1998-2003 Brian Masney <[e-mail]>                  */
/*                                                                           */
/*  This program is free software; you can redistribute it and/or modify     */
/*  it under the terms of the GNU General Public License as published by     */
/*  the Free Software Foundation; either version 2 of the License, or        */
/*  (at your option) any later version.                                      */
/*                                                                           */
/*  This program is distributed in the hope that it will be useful,          */
/*  but WITHOUT ANY WARRANTY; without even the implied warranty of           */
/*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            */
/*  GNU General Public License for more details.                             */
/*                                                                           */
/*  You should have received a copy of the GNU General Public License        */
/*  along with this program; if not, write to the Free Software              */
/*  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111 USA      */
/*****************************************************************************/

/* $Id$ */

#ifndef __GFTPUI_H
#define __GFTPUI_H

#include "../../lib/gftp.h"

typedef struct _gftpui_callback_data gftpui_callback_data;

struct _gftpui_callback_data
{
  gftp_request * request;
  void *uidata;
  char *input_string,
       *source_string;
  GList * files;
  int (*run_function) (gftpui_callback_data * cdata);
};


typedef enum _gftpui_common_request_type
{
  gftpui_common_request_none,
  gftpui_common_request_local,
  gftpui_common_request_remote
} gftpui_common_request_type;


typedef struct _gftpui_common_methods
{
  char *command;
  int minlen;
  int (*func)(void *uidata, gftp_request * request, char *command);
  gftpui_common_request_type reqtype;
  char *cmd_description;
  int (*subhelp_func) (char *topic);
} gftpui_common_methods;

#define gftpui_common_use_threads(request)	(gftp_protocols[(request)->protonum].use_threads)

#define GFTPUI_COMMON_COLOR_BLACK     "\033[30m"
#define GFTPUI_COMMON_COLOR_RED       "\033[31m"
#define GFTPUI_COMMON_COLOR_GREEN     "\033[32m"
#define GFTPUI_COMMON_COLOR_YELLOW    "\033[33m"
#define GFTPUI_COMMON_COLOR_BLUE      "\033[34m"
#define GFTPUI_COMMON_COLOR_MAGENTA   "\033[35m"
#define GFTPUI_COMMON_COLOR_CYAN      "\033[36m"
#define GFTPUI_COMMON_COLOR_WHITE     "\033[37m"
#define GFTPUI_COMMON_COLOR_GREY      "\033[38m"
#define GFTPUI_COMMON_COLOR_DEFAULT   "\033[39m"
#define GFTPUI_COMMON_COLOR_NONE	""

extern sigjmp_buf gftpui_common_jmp_environment;
extern volatile int gftpui_common_use_jmp_environment;
extern gftpui_common_methods gftpui_common_commands[];

/* gftpui.c */
int gftpui_run_callback_function	( gftpui_callback_data * cdata );

int gftpui_common_run_callback_function ( gftpui_callback_data * cdata );

RETSIGTYPE gftpui_common_signal_handler ( int signo );

void gftpui_common_about 		( gftp_logging_func logging_function,
					  gpointer logdata );

int gftpui_common_init			( void *locui,
					  gftp_request * locreq,
					  void *remui,
					  gftp_request * remreq );

int gftpui_common_process_command 	( const char *command );

/* gftpuicallback.c */
int gftpui_common_run_mkdir 		( gftpui_callback_data * cdata );

int gftpui_common_run_rename 		( gftpui_callback_data * cdata );

int gftpui_common_run_site 		( gftpui_callback_data * cdata );

int gftpui_common_run_chdir 		( gftpui_callback_data * cdata );

int gftpui_common_run_chmod		( gftpui_callback_data * cdata );

int gftpui_common_run_ls 		( gftpui_callback_data * cdata );

int gftpui_common_run_delete		( gftpui_callback_data * cdata );

int gftpui_common_run_rmdir 		( gftpui_callback_data * cdata );

/* UI Functions that must be implemented by each distinct UI */
void gftpui_lookup_file_colors 		( gftp_file * fle,
					  char **start_color,
					  char ** end_color );

int gftpui_check_reconnect		( gftpui_callback_data * cdata );

void gftpui_refresh 			( void *uidata );

void *gftpui_generic_thread 		( void *(*run_function)(void *data),
					  void *data);

char *gftpui_prompt_username		( void *uidata,
					  gftp_request * request );

char *gftpui_prompt_password 		( void *uidata,
					  gftp_request * request );

#endif