path: root/src/helpers.h

/* helpers.h -- main header file */

/*
 * This file is part of CliFM
 * 
 * Copyright (C) 2016-2022, L. Abramovich <johndoe.arch@outlook.com>
 * All rights reserved.

 * CliFM 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.
 *
 * CliFM 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., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
*/

#ifndef HELPERS_H
#define HELPERS_H

#if defined(__linux__) && !defined(_BE_POSIX)
# define _GNU_SOURCE
#else
# define _POSIX_C_SOURCE 200809L
# define _DEFAULT_SOURCE
# if defined(__linux__)
#  define _XOPEN_SOURCE /* wcwidth() */
# endif
# if defined(__FreeBSD__)
#  define _XOPEN_SOURCE
#  define __XSI_VISIBLE 700
#  define __BSD_VISIBLE 1
# endif
# ifdef __NetBSD__
#  define _XOPEN_SOURCE
#  define _NETBSD_SOURCE
# endif
# ifdef __OpenBSD__
#  define _BSD_SOURCE
# endif
#endif

/* Setting GLOB_BRACE to ZERO disables support for GLOB_BRACE if not
 * available on current platform */
#if !defined(__TINYC__) && !defined(GLOB_BRACE)
#define GLOB_BRACE 0
#endif

/* Support large files on ARM or 32-bit machines */
#if defined(__arm__) || defined(__i386__)
#define _FILE_OFFSET_BITS 64
//#define _TIME_BITS 64 /* Address Y2038 problem for 32 bits machines */
#endif

/* _NO_LIRA implies _NO_MAGIC */
#ifdef _NO_LIRA
# define _NO_MAGIC
#endif

#include <libintl.h>
#include <regex.h>
#include <stddef.h>
#include <stdlib.h>

#if defined(__linux__)
#include <linux/version.h>
#include <sys/inotify.h>
#include <sys/types.h>
#define LINUX_INOTIFY
#elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)
#include <sys/types.h>
#include <sys/event.h>
#include <sys/time.h>
#define BSD_KQUEUE
#endif /* __linux__ */

#include "init.h"
#include "strings.h"
#include "messages.h"
#include "settings.h"

#if __TINYC__
void *__dso_handle;
#endif

#define EXIT_SUCCESS 0
#define EXIT_FAILURE 1

#ifndef PATH_MAX
#define PATH_MAX 4096
#endif

#ifndef HOST_NAME_MAX
#define HOST_NAME_MAX 64
#endif

#ifndef NAME_MAX
#define NAME_MAX 255
#endif

/* _GNU_SOURCE is only defined if __linux__ is defined and _BE_POSIX
 * is not defined */
#ifdef _GNU_SOURCE
#if (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 28))
#if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 11, 0)
#define _STATX
#endif /* LINUX_VERSION (4.11) */
#endif /* __GLIBC__ */
#endif /* _GNU_SOURCE */

/* Because capability.h is deprecated in BSD */
#if __linux__
#if LINUX_VERSION_CODE >= KERNEL_VERSION(2, 6, 24)
#define _LINUX_CAP
#endif /* LINUX_VERSION (2.6.24)*/
#endif /* __linux__ */

/* Define our own boolean type
#undef bool
#define bool signed char
#undef TRUE
#undef FALSE
#define TRUE 1
#define FALSE 0 */

/* Event handling */
#ifdef LINUX_INOTIFY
#define NUM_EVENT_SLOTS 32 /* Make room for 32 events */
#define EVENT_SIZE (sizeof(struct inotify_event))
#define EVENT_BUF_LEN (EVENT_SIZE * NUM_EVENT_SLOTS)
extern int inotify_fd, inotify_wd;
extern unsigned int INOTIFY_MASK;
#elif defined(BSD_KQUEUE)
#define NUM_EVENT_SLOTS 10
#define NUM_EVENT_FDS 10
extern int kq, event_fd;
extern struct kevent events_to_monitor[];
extern unsigned int KQUEUE_FFLAGS;
extern struct timespec timeout;
#endif /* LINUX_INOTIFY */
extern int watch;

#define PROGRAM_NAME "CliFM"
#define PNL "clifm" /* Program name lowercase */
#define PROGRAM_DESC "The command line file manager"
#ifndef __HAIKU__
#define CLEAR if (write(STDOUT_FILENO, "\033c", 2) <= 0) {}
#else
#define CLEAR fputs("\x1b[H\x1b[2J", stdout);
#endif
#define VERSION "1.4"
#define AUTHOR "L. Abramovich"
#define CONTACT "johndoe.arch@outlook.com"
#define WEBSITE "https://github.com/leo-arch/clifm"
#define DATE "Jan 7, 2022"
#define LICENSE "GPL2+"

/* Options flags */
#define FOLDERS_FIRST (1 << 1)
#define HELP          (1 << 2)
#define HIDDEN        (1 << 3)
#define AUTOLS        (1 << 4)
#define SPLASH        (1 << 5)
#define CASE_SENS     (1 << 6)
#define START_PATH    (1 << 7)
#define PRINT_VERSION (1 << 8)
#define ALT_PROFILE   (1 << 9)

/* File ownership flags */
#define R_USR (1 << 1)
#define X_USR (1 << 2)
#define R_GRP (1 << 3)
#define X_GRP (1 << 4)
#define R_OTH (1 << 5)
#define X_OTH (1 << 6)

/* Internal flags */
#define ROOT_USR      (1 << 10)
#define GUI           (1 << 11)
#define IS_USRVAR_DEF (1 << 12)

/* Used by log_msg() to know wether to tell prompt() to print messages or
 * not */
#define PRINT_PROMPT   1
#define NOPRINT_PROMPT 0

/* Macros for xchdir (for setting term title or not) */
#define SET_TITLE 1
#define NO_TITLE  0

/* Macros for cd_function */
#define CD_PRINT_ERROR    1
#define CD_NO_PRINT_ERROR 0

/* Macros for the count_dir function. CPOP tells the function to only
 * check if a given directory is populated (it has at least 3 files) */
#define CPOP    1
#define NO_CPOP 0

/* Error codes, used by the launch_exec functions */
#define EXNULLERR  79
#define EXFORKERR  81
#define EXCRASHERR 82

#define BACKGROUND 1
#define FOREGROUND 0

#define EMPTY_STR ""

/* A few colors */
#define GRAY   "\x1b[1;30m"
#define _RED   "\x1b[1;31m"
#define _GREEN "\x1b[0;32m"
#define D_CYAN "\x1b[0;36m"
#define BOLD   "\x1b[1m"
#define NC     "\x1b[0m"

/* Colors for file properties */
#define PR_READ    "\x1b[0;1;32m"
#define PR_WRITE   "\x1b[0;1;31m"
#define PR_EXEC    "\x1b[0;1;33m"
#define PR_NONE    "\x1b[0;2;37m"
#define PR_SPECIAL "\x1b[0;1;35m" /* SUID, GUID, ISVTX */
#define PR_DATE    "\x1b[0;34m"
#define PR_ID      "\x1b[1;33m"
#define PR_SIZE    "\x1b[1;32m"
#define PR_NUM_VAL "\x1b[1;36m" /* Properties in octal */

#define COLORS_REPO "https://github.com/leo-arch/clifm-colors"

/* Colors for the prompt: */
/* \001 and \002 tell readline that color codes between them are
 * non-printing chars. This is specially useful for the prompt, i.e.,
 * when passing color codes to readline */
#define RL_NC    "\001\x1b[0m\002"
#define DLFC     "\x1b[0K"         /* Delete line from cursor */
#define CNL      "\x1b[1E"         /* Move the cursor to beginning next line*/
#define DLFC_LEN 4                 /* Length of the above escape codes */

#define UNSET -1

/* Macros for the cp and mv cmds */
#define CP_CP    0
#define CP_ADVCP 1
#define CP_WCP   2
#define MV_MV    0
#define MV_ADVMV 1

/* Macros for listing_mode */
#define VERTLIST 0 /* ls-like listing mode */
#define HORLIST  1

/* Sort macros */
#define SNONE      0
#define SNAME      1
#define SSIZE      2
#define SATIME     3
#define SBTIME     4
#define SCTIME     5
#define SMTIME     6
#define SVER       7
#define SEXT       8
#define SINO       9
#define SOWN       10
#define SGRP       11
#define SORT_TYPES 11

/* Macros for the colors_list function */
#define NO_ELN        0
#define NO_NEWLINE    0
#define NO_PAD        0
#define PRINT_NEWLINE 1

/* A few key macros used by the auto-suggestions system */
#define _ESC   27
#define _TAB   9
#define BS     8
#define DELETE 127
#define ENTER  13
/* #define OP_BRACKET 91
#define UC_O 79
#define SPACE 32 */

/* Macros to specify suggestions type */
#define NO_SUG         0
#define HIST_SUG       1
#define FILE_SUG       2
#define CMD_SUG        3
#define INT_CMD        4
#define COMP_SUG       5
#define BOOKMARK_SUG   6
#define ALIAS_SUG      7
#define ELN_SUG        8
#define FIRST_WORD     9
#define JCMD_SUG       10
#define JCMD_SUG_NOACD 11 /* No auto-cd */
#define VAR_SUG	       12
#define SEL_SUG	       13
#define BACKDIR_SUG	   14

/* 46 == \x1b[00;38;02;000;000;000;00;48;02;000;000;000m\0 (24bit, RGB
 * true color format including foreground and background colors, the SGR
 * (Select Graphic Rendition) parameter, and, of course, the terminating
 * null byte. */
#define MAX_COLOR 46

/* Macros to control file descriptors in exec functions */
#define E_NOFLAG   0
#define E_NOSTDIN  (1 << 1)
#define E_NOSTDOUT (1 << 2)
#define E_NOSTDERR (1 << 3)
#define E_MUTE     (E_NOSTDOUT | E_NOSTDERR)

/* Macros for the backdir (bd) function */
#define BD_TAB    1
#define BD_NO_TAB 0

/* Macros for the clear_suggestion function */
#define CS_FREEBUF 1
#define CS_KEEPBUF 0

/* Macros for the xmagic function */
#define MIME_TYPE 1
#define TEXT_DESC 0

/* Max length of the properties string in long view mode */
#define MAX_PROP_STR 55

/* Macros for the prompt style */
#define DEF_PROMPT_STYLE    0
#define CUSTOM_PROMPT_STYLE 1

/* Macros for the dirjump function */
#define SUG_JUMP    0
#define NO_SUG_JUMP 1

/* Macros for the media_menu function */
#define MEDIA_LIST 	0
#define MEDIA_MOUNT	1

/* Macros for the rl_highlight function */
#define SET_COLOR    1
#define INFORM_COLOR 0

#define MB_LEN_MAX 16

#define TMP_FILENAME ".clifmXXXXXX"

#ifndef P_tmpdir
#define P_tmpdir "/tmp"
#endif

#define itoa xitoa /* itoa does not exist in some OS's */
#define atoi xatoi