assign.sty

\ProvidesPackage{assign}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%OPTIONS%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%highlight option
\newif\ifassign@highlight
\assign@highlightfalse
\DeclareOption{highlight}{
	\assign@highlighttrue
}
%completion boxes option
\newif\ifassign@boxey
\assign@boxeyfalse
\DeclareOption{boxes}{
	\assign@boxeytrue
}
%red overdue assignment option
\newif\ifassign@od
\assign@odfalse
\DeclareOption{od}{
	\assign@odtrue
}
%process the options
\ProcessOptions\relax
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%DEPENDENCIES%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%need to make calendar
\RequirePackage{termcal}
%turn termcal's \setdate into \termcalsetdate (adapted from savesym package)
\expandafter\let\csname termcalsetdate\expandafter\endcsname\csname setdate\endcsname
%undefine setdate
\expandafter\let\csname setdate\endcsname\relax
%need for date manipulation
\RequirePackage{datenumber}
%need for making function with optional arguments work well
\RequirePackage{xparse}
%need for various programming things
\RequirePackage{etoolbox}
%need for processing lengths
\RequirePackage{calc}
\ifassign@highlight
	%need for coloring the highlighting
	\RequirePackage{color}
	%need for highlighting
	\RequirePackage{soul}
\fi
\ifassign@boxey
	%need for making squares and checked squares for completion boxes
	\RequirePackage{wasysym}
\fi
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%VARIABLES%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
\newif\ifassign@done
\assign@donefalse
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%COUNTERS%%%%%%%%%%%%%%%%%%%%%
%
%%%%%%%%%%%%%INTERNAL%%%%%%%%%%%%%%%%%%%%%
%for subtracting
\newcounter{assign@assignmentdatenum}
%reference, for subtracting
\newcounter{assign@truemonth}
%reference value
\setcounter{assign@truemonth}{\month}
%reference, for subtracting
\newcounter{assign@trueyear}
%reference value
\setcounter{assign@trueyear}{\year}
%accessible through setstablemonth
\newcounter{assign@stablemonth}
%initial value
\setcounter{assign@stablemonth}{\month}
%accessible through setstablemonth
\newcounter{assign@stableyear}
%initial value
\setcounter{assign@stableyear}{\year}
%value to subtract assign@assignmentdatenum against
\newcounter{assign@todaysdatenum}
%actual perpetual value
\setmydatenumber{assign@todaysdatenum}{\theassign@trueyear}{\theassign@truemonth}{\day}%
%%%%%%%%%%%%%EXTERNAL%%%%%%%%%%%%%%%%%%%%%
%number of days between now and an assignment for it to be highlighted
\newcounter{hlthreshold}
%default value
\setcounter{hlthreshold}{1}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%REGISTERS%%%%%%%%%%%%%%%%%%%%
%making token register that will hold the entire item based planner
\newtoks{\assign@ibp}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%FUNCTIONS%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
%%%%%%%%%%%%%%INTERNAL%%%%%%%%%%%%%%%%%%%%
%internal highlighting command
\newcommand{\assign@high}{}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%internal command to reset the datenumber date to the "stable" date
\newcommand{\assign@makedatestabledate}{
	\setdate{\theassign@stableyear}{\theassign@stablemonth}{\day}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%internal line divider command
\newcommand{\assign@linedivide}[2]{
	\vskip\csname #1skipamount\endcsname 
	\leaders\vrule width \linewidth\vskip0.4pt
	\vskip\csname #2skipamount\endcsname 
	\nointerlineskip
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\newcommand{\assign@status}{
\ifassign@boxey
	\ifassign@done
	{\huge\CheckedBox}
	\else
	{\huge\Square}
	\fi
\else
\fi
\assign@donefalse}
\newcommand{\done}{
\assign@addtoplanner{\relax\assign@donetrue}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%repeatedly used date setting function
\DeclareDocumentCommand \assign@adaptivedate { o o o}{ 
\ifboolexpr{
		%Check if there are none of the optional values (month, day, year)
		test {\IfNoValueTF{#1}}
		and 
		test {\IfNoValueTF{#2}}
		and
		test {\IfNoValueTF{#3}}
	}
		%if so, make a command to do nothing
		{\def\assign@internaldate{}}
		{
			\ifboolexpr{
				%Check if there is only one optional value (day)
				not test {\IfNoValueTF{#1}}
				and 
				test {\IfNoValueTF{#2}}
				and
				test {\IfNoValueTF{#3}}
			}
				%if so, make a command setting the datenumber package date to stable year, stable month, specified day
				{\def\assign@internaldate{\setdate{\theassign@stableyear}{\theassign@stablemonth}{#1}}}
				{
					\ifboolexpr{
						%Check if there are two optional values (month, day)
						not test {\IfNoValueTF{#1}}
						and 
						not test {\IfNoValueTF{#2}}
						and
						test {\IfNoValueTF{#3}}
					}
						%if so, make a command setting the datenumber package date to stable year, specified month, specified day
						{\def\assign@internaldate{\setdate{\theassign@stableyear}{#1}{#2}}}
						%if not, then all three optional arguments must have been given, make a command setting the datenumber package date to specified year, specified month, specified day
						{\def\assign@internaldate{\setdate{#3}{#1}{#2}}}
				}
	}
	%set the date to what it should be
	\assign@internaldate
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%Quick command for the standard format of expressing a due date
\def\assign@preentrytail{\datedayname,~\datemonthname~{\thedateday},~\thedateyear}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%Builder functions
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%adds tokens to calendar, expanding first token
\newcommand{\assign@addtocalendar}[1]{
\expandafter\caltext\expandafter{\expandafter\thedatemonth\expandafter/\expandafter\thedateday\expandafter/\expandafter\thedateyear\expandafter}\expandafter{#1}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%add a string of tokens #2 to a token register #1
\newcommand\assign@appendtotokenreg[2]{
#1\expandafter{\the#1#2}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%adds tokens to planner, expanding first token
\newcommand{\assign@addtoplanner}[1]{
\expandafter\assign@appendtotokenreg\expandafter{\expandafter\assign@ibp\expandafter}\expandafter{#1}
}
%adds tokens to planner in a parbox without expanding
\newlength\assign@statusspace
\ifassign@boxey
\newcommand{\assign@boxtoplanner}[1]{
	\assign@addtoplanner{\relax
		\parbox{\linewidth-19pt}{#1}
	}
}
\else
\newcommand{\assign@boxtoplanner}[1]{
	\assign@addtoplanner{\relax
		\parbox{\linewidth}{#1}
	}
}
\fi
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\ifassign@od
	\definecolor{overduecolor}{rgb}{.768,.118,.227}
\else
	\definecolor{overduecolor}{cmyk}{0,0,1,0}
\fi
\newcommand{\enablehighlighting}[1]{
	\sethlcolor{#1}
	\ifassign@highlight
		%making the \assign@highcommand into a real highlighting command
		\renewcommand{\assign@high}[1]{\hl{##1}}
	\else
		%if no highlight option, make the highlight command into a dummy command that just passes back the argument
		\renewcommand{\assign@high}[1]{##1}
	\fi
}
\newcommand{\disablehighlighting}{
	\renewcommand{\assign@high}[1]{##1}
}
\newcommand{\assign@highlightdefiner }[3]{%
	%add the date you know to the register, expanded, but not executed
	\assign@addtoplanner{\assign@adaptivedate[#1][#2][#3]}				
	%set the date to the specified date
	\assign@adaptivedate[#1][#2][#3]
	%set the assign@assignmentdatenum to the absolute datenum of the given datenumber package date for the assignment date, not the real date, remember that was set at the top of the function
	\setmydatenumber{assign@assignmentdatenum}{\thedateyear}{\thedatemonth}{\thedateday}%
	%find the difference between the two absolute datenums, or the number of days between
	\addtocounter{assign@assignmentdatenum}{-\theassign@todaysdatenum}%
	%check if this gap is less than the supplied threshold value or the default, 2
	\ifnumcomp{\theassign@assignmentdatenum}{<}{\thehlthreshold+1}
	{
		\ifnumcomp{\theassign@assignmentdatenum}{<}{0}
		{
			\assign@addtoplanner{\relax
				\enablehighlighting{overduecolor}
			}
		}
		{
			\assign@addtoplanner{\relax
				\enablehighlighting{yellow}
			}
		}
	}
	{
	%if not, don't highlight the assignment, description or the due date, add it to token register
		\assign@addtoplanner{\relax
			\disablehighlighting
		}
	}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%EXTERNAL%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%for archival purposes, allow a planner to evaluate like its a month it isn't.
%syntax: \setstablemonth{month}{year}
\newcommand{\setstablemonth}[2]{
	\setcounter{assign@stablemonth}{#1}
	\setcounter{assign@stableyear}{#2}
	\month=#1
	\year=#2
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%command to make a new class (or group) on the planner, and tags for the calendar.
%syntax: \class{title}
\newcommand{\class}[1]{
	%add class header to token register
	\assign@ibp\expandafter{\the\assign@ibp{
	%low priority pagebreak
	\pagebreak[1]
	%make a page spanning line
	\assign@linedivide{big}{med}
	%Indented and bolded class title
	\noindent\hspace*{15pt} \textbf{\uppercase{#1}}\\[10pt]}}
	%Make the current class accessible from other commands
	\def\assign@currentclass{#1: }
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%command to unset the currentclass command, to make assignments without classes on calendar
\newcommand{\nullclass}{
\def\assign@currentclass{}
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%command to add an assignment.  Syntax: \assign{title}{month}{day}{year} or \assign{title}{month}{day} or \assign{title}{day} or \assign{title}
\DeclareDocumentCommand \assign { m o o o}{ 
	%within an evaluation, start with the date, as established either by truth or by \setstablemonth
	\assign@makedatestabledate
	%every type of entry requires some vertical space
	\assign@addtoplanner{\relax\vspace{2pt}}
	\ifboolexpr{
		%Check if there are none of the optional values (month, day, year)
		test {\IfNoValueTF{#2}}
		and 
		test {\IfNoValueTF{#3}}
		and
		test {\IfNoValueTF{#4}}
	}
		{
			%if so, just put the description and the question mark into the token register, never with highlighting
			\assign@addtoplanner{\relax\assign@status}
			\assign@boxtoplanner{	
				{#1}\\
				\hspace*{15pt} ?
			}
		}
		{
			%for the instances that some optional argument, hence date, has been given, now we'll make the actual formatted entry
			\assign@highlightdefiner{#2}{#3}{#4}
			\assign@addtoplanner{\relax\assign@status}
			\assign@boxtoplanner{
			\assign@high{#1}\\
			\hspace*{15pt}\assign@high{\mbox{\assign@preentrytail}}
			}
			%Adding entry to calendar using assign@addtocalendar
			\assign@addtocalendar{\assign@currentclass #1\assign@linedivide{small}{small}} 
		}
	\assign@addtoplanner{\relax\\}
	%just so no other function is messed up, set the datenumber package date back to the stable date
	\assign@makedatestabledate
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%command to make an assignment with an italicized description that isn't printed on the calendar
%syntax: \assign{title}{description}{month}{day}{year} or \assign{title}{description}{month}{day} or \assign{title}{description}{day} or \assign{title}{description}
\DeclareDocumentCommand \dassign { m m o o o}{ 
	%within an evaluation, start with the date, as established either by truth or by \setstablemonth
	\assign@makedatestabledate
	%every type of entry requires some vertical space
	\assign@addtoplanner{\relax\vspace{2pt}}
	\ifboolexpr{
		%Check if there are none of the optional values (month, day, year)
		test {\IfNoValueTF{#3}}
		and 
		test {\IfNoValueTF{#4}}
		and
		test {\IfNoValueTF{#5}}
	}
		{
			\assign@addtoplanner{\relax\assign@status}
		%if so, just put the title, description and the question mark into the token register, never with highlighting
			\assign@boxtoplanner{{#1:}\\
			\hspace*{15pt}\parbox{\linewidth-15pt}{\emph{#2}}\\
			\hspace*{15pt} ?}
		}
		{	
			%for the instances that some optional argument, hence date, has been given, now we'll make the actual formatted entry
			\assign@highlightdefiner{#3}{#4}{#5}
			\assign@addtoplanner{\relax\assign@status}
			\assign@boxtoplanner{
					\assign@high{#1:}\\
					\hspace*{15pt}\parbox{\linewidth-15pt}{\emph{\assign@high{#2}}}\\
					\hspace*{15pt}\assign@high{\mbox{\assign@preentrytail}}
			}
			%Adding entry to calendar using assign@addtocalendar
			\assign@addtocalendar{\assign@currentclass #1\assign@linedivide{small}{small}} 
		}
	\assign@addtoplanner{\relax\\}
	%just so no other function is messed up, set the datenumber package date back to the stable date
	\assign@makedatestabledate
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%command to add an event to calendar, without showing in planner.  
%Syntax: \event{title}{month}{day}{year} or \event{title}{month}{day} or \event{title}{day} or \event{title}
\DeclareDocumentCommand \event{ m o o o}{ 
	%within an evaluation, start with the date, as established either by truth or by \setstablemonth
	\assign@makedatestabledate
	\ifboolexpr{
		%Check if there are none of the optional values (month, day, year)
		test {\IfNoValueTF{#2}}
		and 
		test {\IfNoValueTF{#3}}
		and
		test {\IfNoValueTF{#4}}
	}
		{
		%if so, just put the title and the question mark into the token register, never with highlighting
			%if not, don't add a description
			\assign@addtoplanner{\relax\vspace{2pt}}
			\ifassign@boxey
			\assign@addtoplanner{\hspace{18pt}}
			\fi
			\assign@boxtoplanner{{\textbf{#1}}\\
			\hspace*{15pt} \textbf{?}}
			\assign@addtoplanner{\relax\\}
		}
		{
		%set the date to the specified date
			\assign@adaptivedate[#2][#3][#4]
				%Adding entry to calendar using assign@addtocalendar
				\assign@addtocalendar{\expandafter\textbf\expandafter{\assign@currentclass #1\assign@linedivide{small}{small}}} 
		}
	\assign@donefalse
	%just so no other function is messed up, set the datenumber package date back to the stable date
	\assign@makedatestabledate
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%DISPLAY%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%command to actually print the item based planner.  No arguments
\newcommand\printplanner{\raggedright\the\assign@ibp}
%The Calendar Command Syntax: \printcalendar{startdate mm/dd/yyyy}{no. of weeks}
\newcommand\printcalendar[2]
{
	%Make datenumbersetdate off of setdate
	\expandafter\global\expandafter\let\csname datenumbersetdate\expandafter\endcsname%
	\csname setdate\endcsname
	%Make setdate off of termcalsetdate
	\expandafter\global\expandafter\let\csname setdate\expandafter\endcsname%
	\csname termcalsetdate\endcsname
	%start the calendar with the right date and weeks
	\begin{calendar}{#1}{#2}
		%all the days are important, but not numbered
		\calday[Sunday]{\noclassday}
		\calday[Monday]{\noclassday}
		\calday[Tuesday]{\noclassday}
		\calday[Wednesday]{\noclassday}
		\calday[Thursday]{\noclassday}
		\calday[Friday]{\noclassday}
		\calday[Saturday]{\noclassday}
	\end{calendar}
	%Make calsetdate off of setdate
	\expandafter\global\expandafter\let\csname calsetdate\expandafter\endcsname%
	\csname setdate\endcsname
	%Make setdate off of datenumbersetdate
	\expandafter\global\expandafter\let\csname setdate\expandafter\endcsname%
	\csname datenumbersetdate\endcsname
}