help.c

/*************************************************************
 *
 * File:        help.c
 * Author:      David Kelley
 * Description: In program help
 *
 * Copyright (C) 2009 David Kelley
 *
 * This file is part of bviplus.
 *
 * Bviplus 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 3 of the License, or
 * (at your option) any later version.
 *
 * Bviplus 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 bviplus.  If not, see <http://www.gnu.org/licenses/>.
 *
 *************************************************************/

#include <string.h>
#include <stdlib.h>
#include "display.h"
#include "user_prefs.h"
#include "app_state.h"
#include "virt_file.h"
#include "search.h"
#include "key_handler.h"
#include "help.h"


char *help_text[] = {
  "Bviplus is designed to be as similar to vim as possible.",
  "Here are some basics:",
  " ",
  "For this help dialogue:",
  "  :help",
  " ",
  "Command/Insert toggle",
  "  ESC             Exit insert mode",
  "  i               Insert before",
  "  a               Insert after",
  " ",
  "Saving/Quitting:",
  "  :e [filename]   Open 'filename' or newfile if none specified",
  "  :e!             Reload current file discarding changes",
  "  :q              Quit",
  "  :q!             Quit without saving",
  "  :qa             Quit all",
  "  :qa!            Quit all without saving",
  "  :w              Save",
  "  :wa             Save all",
  "  :wq             Save and quit",
  "  :wqa            Save all and quit",
  "  :waq",
  "  :w <name>       Save as <name>",
  " ",
  "Movement in command mode:",
  "  TAB KEY         Move between HEX/ASCII windows",
  "  k               Move up",
  "  j               Move down",
  "  h               Move left",
  "  l               Move right",
  "  (Arrow keys also work)",
  " ",
  "More movement:",
  "  <number>G       Jump to address <number>",
  "  :<number>       Jump to address <number>",
  "  :0x<hex number> Jump to address <hex number>",
  "  0               Move to beginning of line",
  "  HOME KEY",
  "  ^",
  "  $               Move to end of line",
  "  END KEY",
  "  m<0-9,a-z,A-Z>  Set mark at cursor location",
  "  `<0-9,a-z,A-Z>  Jump to mark",
  "  PAGE_DOWN KEY   Page down",
  "  PAGE_UP KEY     Page up",
  "  /               Ascii search",
  "  \\               Hex search",
  "  ?/              Reverse ascii search",
  "  ?\\              Reverse hex search",
  "  n               Next search match",
  "  N               Previous search match",
  " ",
  "Editing:",
  "  v               Toggle visual select mode",
  "                  (ESC exits visual select mode)",
  "  x               Delete byte or selection",
  "  X               Delete previous byte",
  "  r               Replace byte or selection",
  "  R               Overwrite",
  "  y               Yank byte or selection",
  "  Y",
  "  p               Paste after",
  "  P               Paste before",
  "  d               Delete to next motion",
  "  D",
  "  u               Undo",
  "  U               Redo",
  " ",
  "Searching:",
  "  Searching is \"non greedy\", meaning wildcards will match",
  "  the least number of bytes possible",
  " ",
  "  /<pattern>               Ascii search",
  "  \\<pattern>               Hex search",
  "  ?/<pattern>              Reverse ascii search",
  "  ?\\<pattern>              Reverse hex search",
  "  Pattern options:",
  "    \\            Escape the next character (do not interpret as special char)",
  "    .            Match any char/byte",
  "    ?            Match the previous char/byte none or one times",
  "    *            Match the previous char/byte none or more times",
  "    +            Match the previous char/byte one or more times",
  "    [<range>]    Match any of the chars/bytes in <range>",
  "    [^<range>]   Match none of the chars/bytes in <range>",
  "    <range>:",
  "        Specify as list of characters or range with -",
  "        ascii e.g. [abc] or [a-z]",
  "        hex e.g. [04f53b] or [04-5h]",
  " ",
  "Settings:",
  "       Option               Arguments    Default   Alias      Effect",
  "       ------               ---------    -------   -----      ------",
  "  :set                                                        Show settings",
  "  :set binary               <on|off>     off       bin        Binary display *",
  "  :set little_endian        <on|off>     off       le         Little endian *",
  "  :set grouping             <1-16>       1         grp        Set byte grouping *",
  "  :set blob_grouping        <0-n>        0         blob       Highlight grouping",
  "  :set blob_grouping_offset <0-n>        0         bloboff    Highligh offset",
  "  :set columns              <1-n>        0         cols       Set the max cols",
  "  :set search_hl            <on|off>     on        hl         Search highlighting",
  "  :set search_immediate     <on|off>     on        si         Searching auto matically moves cursor to next match",
  "  :set ignorecase           <on|off>     on        case       Case sensativ search",
  "  :set max_match            <0-n>        256       mm         Maximum search match size (0=no max, bigger=slower)",
  " ",
  "  >                Increase blob_grouping_offset",
  "  <                Decrease blob_grouping_offset",
  " ",
  "  * Experimental, may cause display problems ",
  " ",
  "ESC ESC temporarily turns off search highlighting (until next search)",
  " ",
  "Configuration file:",
  "  bviplus will look for your configuration file in $HOME/.bviplusrc",
  "  The configuration file may be used to set the defaul for any parameters which can be changed using the ':set' command",
  "  The format for the configuration file is line separated <option> [= value], just as you would do with :set <option> [= value]",
  "  e.g.",
  "    # Comments begin with a '#' mark",
  "    cols=40",
  "    nohl",
  " ",
  "Running external programs on data sets:",
  "  (First select 1 or more bytes using visual select)",
  "  :ex <external program>                    Run the external program on the visual select data.",
  "  :external <external program>              The program should be one which reads from",
  "                                            stdin and writes to stdout.",
  "                                            eg. ':ex md5sum'",
  " ",
  "Files:",
  "  :bn             Next file",
  "  :next",
  "  ~",
  " ",
  "  :bp             Last file",
  "  :prev",
  "  :previous",
  "  :last",
  " ",
  "  alt+<n>         Switch to <n>th open file",
  " ",
  "Macros:",
  "  Record macros with:",
  "    q<storage key><macro contents>q",
  "  Play macros with:",
  "    @<storage key>",
  "  Valid storage keys are a-z",
  "  If '@' is specified as the storage key when playing back a macro, the last macro played back is played again",
  " ",
  0,
};

void scrollable_window_display(char **text)
{
  WINDOW *scrollbox;
  int i, y = 0, c = 0, update = 1, scroll_lines = SCROLL_BOX_H - 4, len = 0;

  scrollbox = newwin(SCROLL_BOX_H, SCROLL_BOX_W, SCROLL_BOX_Y, SCROLL_BOX_X);

  while (text[len] != NULL)
    len++;

  curs_set(0);

  do
  {
    switch(c)
    {
      case 'j':
      case KEY_DOWN:
        y++;
        if (y>(len - (SCROLL_BOX_H - 10)))
        {
          y--;
          flash();
        }
        else
          update = 1;
        break;
      case 'k':
      case KEY_UP:
        y--;
        if (y<0)
        {
          y++;
          flash();
        }
        else
          update = 1;
        break;
    case BVICTRL('f'):
    case KEY_NPAGE:
        if (y == (len - (SCROLL_BOX_H - 10)))
        {
          flash();
        }
        else
        {
          y+=(SCROLL_BOX_H-4);
          if (y > (len - (SCROLL_BOX_H - 10)))
            y = (len - (SCROLL_BOX_H - 10));
          update = 1;
        }
        break;
    case BVICTRL('b'):
    case KEY_PPAGE:
        if (y == 0)
        {
          flash();
        }
        else
        {
          y-=(SCROLL_BOX_H-4);
          if (y<0)
            y=0;
          update = 1;
        }
        break;
    }

    if (update)
    {
      update = 0;
      werase(scrollbox);
      box(scrollbox, 0, 0);
      for (i=0; i<scroll_lines; i++)
      {
        if ((i+y) < len)
          mvwaddstr(scrollbox, i+1, 1, text[i+y]);
      }
      mvwprintw(scrollbox, SCROLL_BOX_H - 3, 1, "_________________________________________");
      mvwprintw(scrollbox, SCROLL_BOX_H - 2, 1, " [j|DOWN] Down  [k|UP] Up  [q|ESC] Quit |");
      wrefresh(scrollbox);
    }
    c = mwgetch(scrollbox);
  } while(c != 'q' && c != ESC);

  delwin(scrollbox);

  curs_set(1);
  print_screen(display_info.page_start);
}

/* max_size is maximum array index (e.g. number of bytes-1) */
void big_buf_display(char *buf, int max_size)
{
  char *this, *line, *end;
  char **text;
  int index = 0;

  end = strchr(buf, EOF);
  if (end == NULL)
    end = buf+max_size;

  if (end >= buf+max_size)
    end = buf+max_size;

  /* count newlines */
  line = buf;
  while ((this = strchr(line , '\n')) != NULL)
  {
    index++;
    line = this+1;
  }

  /* array of strings: extras for non-newline last line and delimeter */
  text = malloc(sizeof(char *)*(index+2));

  /* change newlines to nul and save a reference */
  index = 0;
  line = buf;
  while ((this = strchr(line, '\n')) != NULL)
  {
    text[index++] = line;
    *this = 0;
    line = this+1;
  }
  *end = 0;

  if(line < end)
    text[index++] = line;

  text[index] = NULL;

  scrollable_window_display(text);
  free(text);
}