Collected notes on programming.

computer science dictionary

bash

Notes on shell scripting.

Bash is a Unix shell and command language originally released in 1989. It can read and execute text files called shell script that are useful for automating tasks.

The terminal cheatsheet contains some of the commands that can be run as part of a bash script.

Running a script

Navigate to the directory containing the script and use ./scriptname.sh to execute it.

If the script fails with an permissions error, use chmod +x scriptname.sh to make it executable.

#! Shebang. Indicates which interpreter a script should be run with: #!/bin/bash
$1, $2, ... The first, second, etc command line arguments to the script.
variable=value To set a value for a variable. Remember, no spaces on either side of the equal sign

Conditional logic

# conditional logic
if [ -d $HOME ]; then
  echo "The home directory path is $HOME"
else
  echo "Couldn't find home directory!"
fi

# use semi colon when writing one liners
if [ -f $file ]; then echo "Found $file"; fi

# use double brackeds to combine conditions
if [[ $condition == true && ! -n $value ]]; then
	echo "The $condition is true and value was not set."
fi

# comparisons
if [[ $value -gt 0 && $value -lt 100 ]]; then
	echo "$value is greater than 0 and less than 100"
fi

Strings

# print variable to text file overwriting existing content
echo $string > $file

# append a string to a text file
echo $string >> $file

# store file content as variable
string=$(cat $file)

# read from stdin
read -p "> " $string
echo "You entered $string"

# print the length of a string
${#string}

# replace substring
string="The wind came from North East"
string=${string/"East"/"West"} # "The wind came from North West"

# find substring in string
if [[ $subString == "$string"* ]]; then 
  echo "$subString was found at the beginning of $string"
elif [[ $subString == *"$string"* ]]; then 
  echo "$subString was found in the middle of $string"
elif [[ $subString == *"$string" ]]; then 
  echo "$subString was found at the end of $string"
else 
  echo "$subString was not found in $string"
fi

# manipulating filenames
path="directory/file.txt"
local file=$(basename $path)   # file.txt
local fileName="${file%%.*}"   # file
local fileExt="${fileName#*.}" # ext

# font formatting
bold=$(tput bold)
normal=$(tput sgr0)
echo "${bold}This text is bold.${normal}"

Arrays

#!/bin/bash
# define an array
array=( "item1" "item2" "item3" )

# get the size of an array
echo ${#array[@]}

# loop through array items
for item in ${array[@]}; do
  echo $item
done

# read words from file and store them in an array
file="words.txt"
words=()
count=0
# read from file
while read line; do
  words[$count]="$line"
  let count++
done < $file
# read from array
for line in "${words[@]}"; do
  echo ${line}
done

Loops

# reads a text file line by line
while read line; do
  echo $line
done < $file

# count files in folder
count=0
for $file in $path/*; do
  echo $file
  let count++
done

# print files of type txt
for $file in $path/*.txt; do
  echo $file
done

Snippets

# start a program as a forked process in a new window
programname &

# erases the last line printed in the terminal
tput cuu1;tput el;

# stopping time for script execution duration
startBuild=$(date +%s,%N)
_s1=$(echo $startBuild | cut -d',' -f1)   # sec
_s2=$(echo $startBuild | cut -d',' -f2)   # nano sec
# run commands
end_at=$(date +%s,%N)
_e1=$(echo $end_at | cut -d',' -f1)
_e2=$(echo $end_at | cut -d',' -f2)
# calculate passed time in seconds
passedTime=$(bc <<< "scale=3; $_e1 - $_s1 + ($_e2 -$_s2)/1000000000")
echo "The process took $passedTime seconds."

Debugging

Use set with the following parameters for easier debugging:

e Halts on the first error.
u Halts on unset variables.
o -pipefail Halts on errors in pipeline.
v Prints each line before it is executed.
x Prints each line after all substitutions and expansions have been performed.

Evaluating the arguments passed to a script

#!/bin/bash
# case example
case $1 in
 start)
  echo starting
   ;;
 stop)
  echo stoping
   ;;
 restart)
  echo restarting
   ;;
 *)
  echo don\'t know
   ;;
esac

clang

Notes on the C programming language.

C is a widely used programming language, developed by Brian Kernighan and Dennis Ritchie during the 1970s. It is closely tied to the development of the Unix operating system.

A program written in C needs to be compiled - I use the Ubuntu pre-installed gcc. C programs can be debugged using GDB.

Pointers

type *ptr A pointer of type named ptr
*prt The value of whatever prt is pointed at
*(ptr + i) The value of (whatever prt is pointed at plus i)
&thing The address of thing
type *ptr = &thing A pointer of type named ptr set to the address of thing

Converting strings to integers

ASCII Decimal
0 48
1 49
2 50
3 51
4 52
5 53
6 54
7 55
8 56
9 57

gdb

Notes on debugging.

The GNU Project debugger, displays what is going on 'inside' a program while it executes - or what it was doing at the moment it crashed.

Commands

gdb ./program starts gdb
run executes the code
s steps to the next line
n jumps over the next function
c continues execution
l prints 5 lines above and below current statement
break sets a breakpoint either at line number of function name
watch stops the execution everytime a variable value changes
display prints a variable value on execution stops
info displays information on breakpoints and watchpoints
clear # removes the breakpoint at line #
condition 1 i == "test" breaks at breakpoint 1 when i is "test"

regex

Find and replace.

Regular expressions are useful for extracting information from any text by searching one or more matches of a specific pattern.

A regex usually comes within this form /abc/ where the search pattern is delimited by two slash characters /.

Anchors

^The matches any string that starts with The
end$ matches a string that ends with end
^The end$ exact string match (starts and ends with The end)
long matches any string that has the text long in it

Quantifiers

abc* matches a string that has ab followed by zero or more c
abc+ matches a string that has ab followed by one or more c
abc? matches a string that has ab followed by zero or one c

Character classes

User uppercase to negate.

\d* matches a single character that is a digit
\w* matches a word character (alphanumeric character plus underscore)
\s* matches a whitespace character (includes tabs and line breaks)
.* matches any character

Escaping

In order to be taken literally, you must escape the characters ^.[$()|*+?{\ with a backslash \ as they have special meaning.

Flags

g global does not return after the first match, restarting the subsequent searches from the end of the previous match
m multi-line when enabled ^ and $ will match the start and end of a line, instead of the whole string
i insensitive makes the whole expression case-insensitive (for instance /aBc/i would match AbC)

uxntal

An esoteric flavor of Assembly.

For extensive notes, refer to the illustrated uxn notes.

incoming(2) | preonic | planck ez