terminal.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef _GUAC_TERMINAL_H
#define _GUAC_TERMINAL_H
 
#include <pthread.h>
#include <stdbool.h>
 
#include <guacamole/client.h>
#include <guacamole/stream.h>
 
#define GUAC_TERMINAL_DEFAULT_FONT_NAME "monospace"
 
#define GUAC_TERMINAL_DEFAULT_FONT_SIZE 12
 
#define GUAC_TERMINAL_DEFAULT_MAX_SCROLLBACK 1000
 
#define GUAC_TERMINAL_DEFAULT_BACKSPACE 127
 
#define GUAC_TERMINAL_DEFAULT_COLOR_SCHEME ""
 
#define GUAC_TERMINAL_DEFAULT_DISABLE_COPY false
 
#define GUAC_TERMINAL_MAX_ROWS 1024
 
#define GUAC_TERMINAL_MAX_COLUMNS 1024
 
#define GUAC_TERMINAL_FRAME_DURATION 40
 
#define GUAC_TERMINAL_FRAME_TIMEOUT 10
 
#define GUAC_TERMINAL_MAX_TABS       16
 
#define GUAC_TERMINAL_WHEEL_SCROLL_AMOUNT 3
 
#define GUAC_TERMINAL_PIPE_INTERPRET_OUTPUT 1
 
#define GUAC_TERMINAL_PIPE_AUTOFLUSH 2
 
typedef struct guac_terminal guac_terminal;
 
typedef enum guac_terminal_cursor_type {
 
    GUAC_TERMINAL_CURSOR_BLANK,
 
    GUAC_TERMINAL_CURSOR_IBAR,
 
    GUAC_TERMINAL_CURSOR_POINTER
 
} guac_terminal_cursor_type;
 
typedef void guac_terminal_upload_path_handler(guac_client* client, char* path);
 
typedef guac_stream* guac_terminal_file_download_handler(guac_client* client, char* filename);
 
typedef struct guac_terminal_options {
 
    bool disable_copy;
 
    int max_scrollback;
 
    char* font_name;
 
    int font_size;
 
    int dpi;
 
    int width;
 
    int height;
 
    char* color_scheme;
 
    int backspace;
 
} guac_terminal_options;
 
guac_terminal* guac_terminal_create(guac_client* client,
        guac_terminal_options* terminal_options);
 
guac_terminal_options* guac_terminal_options_create(
        int width, int height, int dpi);
 
void guac_terminal_free(guac_terminal* term);
 
void guac_terminal_set_upload_path_handler(guac_terminal* terminal,
        guac_terminal_upload_path_handler* upload_path_handler);
 
void guac_terminal_set_file_download_handler(guac_terminal* terminal,
        guac_terminal_file_download_handler* file_download_handler);
 
int guac_terminal_render_frame(guac_terminal* terminal);
 
int guac_terminal_read_stdin(guac_terminal* terminal, char* c, int size);
 
void guac_terminal_start(guac_terminal* term);
 
void guac_terminal_stop(guac_terminal* term);
 
void guac_terminal_notify(guac_terminal* terminal);
 
char* guac_terminal_prompt(guac_terminal* terminal, const char* title,
        bool echo);
 
int guac_terminal_printf(guac_terminal* terminal, const char* format, ...);
 
int guac_terminal_send_key(guac_terminal* term, int keysym, int pressed);
 
int guac_terminal_send_mouse(guac_terminal* term, guac_user* user,
        int x, int y, int mask);
 
int guac_terminal_send_data(guac_terminal* term, const char* data, int length);
 
int guac_terminal_send_string(guac_terminal* term, const char* data);
 
int guac_terminal_write(guac_terminal* term, const char* buffer, int length);
 
int guac_terminal_send_stream(guac_terminal* term, guac_user* user,
        guac_stream* stream);
 
int guac_terminal_sendf(guac_terminal* term, const char* format, ...);
 
void guac_terminal_dup(guac_terminal* term, guac_user* user,
        guac_socket* socket);
 
void guac_terminal_sync_users(
        guac_terminal* term, guac_client* client, guac_socket* socket);
 
int guac_terminal_resize(guac_terminal* term, int width, int height);
 
int guac_terminal_get_available_scroll(guac_terminal* term);
 
int guac_terminal_get_rows(guac_terminal* term);
 
int guac_terminal_get_columns(guac_terminal* term);
 
void guac_terminal_clipboard_reset(guac_terminal* terminal,
        const char* mimetype);
 
void guac_terminal_clipboard_append(guac_terminal* terminal,
        const char* data, int length);
 
void guac_terminal_remove_user(guac_terminal* terminal, guac_user* user);
 
int guac_terminal_create_typescript(guac_terminal* term, const char* path,
        const char* name, int create_path);
 
void guac_terminal_apply_color_scheme(guac_terminal* terminal,
        const char* color_scheme);
 
const char* guac_terminal_get_color_scheme(guac_terminal* terminal);
 
void guac_terminal_apply_font(guac_terminal* terminal, const char* font_name,
        int font_size, int dpi);
 
const char* guac_terminal_get_font_name(guac_terminal* terminal);
 
int guac_terminal_get_font_size(guac_terminal* terminal);
 
int guac_terminal_get_mod_ctrl(guac_terminal* terminal);
 
#endif