latex2e-20160201/base/ltlength.dtx

   1 % \iffalse meta-comment
   2 %
   3 % Copyright 1993-2016
   4 % The LaTeX3 Project and any individual authors listed elsewhere
   5 % in this file.
   6 %
   7 % This file is part of the LaTeX base system.
   8 % -------------------------------------------
   9 %
  10 % It may be distributed and/or modified under the
  11 % conditions of the LaTeX Project Public License, either version 1.3c
  12 % of this license or (at your option) any later version.
  13 % The latest version of this license is in
  14 %    http://www.latex-project.org/lppl.txt
  15 % and version 1.3c or later is part of all distributions of LaTeX
  16 % version 2005/12/01 or later.
  17 %
  18 % This file has the LPPL maintenance status "maintained".
  19 %
  20 % The list of all files belonging to the LaTeX base distribution is
  21 % given in the file `manifest.txt'. See also `legal.txt' for additional
  22 % information.
  23 %
  24 % The list of derived (unpacked) files belonging to the distribution
  25 % and covered by LPPL is defined by the unpacking scripts (with
  26 % extension .ins) which are part of the distribution.
  27 %
  28 % \fi
  29 %
  30 % \iffalse
  31 %%% From File: ltlength.dtx
  32 %
  33 %<*driver>
  34 % \fi
  35 \ProvidesFile{ltlength.dtx}
  36              [2015/01/08 v1.1c LaTeX Kernel (Lengths)]
  37 % \iffalse
  38 \documentclass{ltxdoc}
  39 \GetFileInfo{ltlength.dtx}
  40 \title{\filename}
  41 \date{\filedate}
  42  \author{%
  43   Johannes Braams\and
  44   David Carlisle\and
  45   Alan Jeffrey\and
  46   Leslie Lamport\and
  47   Frank Mittelbach\and
  48   Chris Rowley\and
  49   Rainer Sch\"opf}
  50
  51 \begin{document}
  52  \MaintainedByLaTeXTeam{latex}
  53  \maketitle
  54  \DocInput{\filename}
  55 \end{document}
  56 %</driver>
  57 % \fi
  58 %
  59 % \CheckSum{53}
  60 %
  61 % \changes{v1.0c}{1994/03/29}
  62 %     {Create file ltcntlen from parts of ltmiscen and ltherest.}
  63 % \changes{v1.1a}{1994/05/19}
  64 %     {Extract file ltlength from ltcntlen.}
  65 % \changes{v1.1b}{1995/08/11}
  66 %     {Doc typos fixed for latex/753}
  67 %
  68 % \section{Lengths}
  69 %
  70 % \DescribeMacro{\newlength}
  71 % Declare |#1| to be a new length command.
  72 %
  73 % \DescribeMacro{\setlength}
  74 % Set the length command, |#1|, to the value |#2|.
  75 %
  76 % \DescribeMacro{\addtolength}
  77 % Increase the value of  the length command, |#1|, by the value |#2|.
  78 %
  79 % \DescribeMacro{\settowidth}
  80 % Set the length, |#1| to the width of a box containing |#2|.
  81 %
  82 % \DescribeMacro{\settoheight}
  83 % Set the length, |#1| to the height of a box containing |#2|.
  84 %
  85 % \DescribeMacro{\settodepth}
  86 % Set the length, |#1| to the depth of a box containing |#2|.
  87 %
  88 % \StopEventually{}
  89 %
  90 %    \begin{macrocode}
  91 %<*2ekernel>
  92 \message{lengths,}
  93 %    \end{macrocode}
  94 %
  95 % \begin{macro}{\newlength}
  96 %    \begin{macrocode}
  97 \def\newlength#1{\@ifdefinable#1{\newskip#1}}
  98 %    \end{macrocode}
  99 % \end{macro}
 100 %
 101 % \begin{macro}{\setlength}
 102 % \changes{v1.1c}{2015/01/08}{add = to ensure first length argument is terminated.
 103 %             (latexrelease)}
 104 %    \begin{macrocode}
 105 %</2ekernel>
 106 %<latexrelease>\IncludeInRelease{2015/01/01}%
 107 %<latexrelease>                 {\setlength}{Using \setlength with \dimen0}%
 108 %<*2ekernel|latexrelease>
 109 %    \end{macrocode}
 110 %    \begin{macrocode}
 111 \def\setlength#1#2{#1 #2\relax}
 112 %</2ekernel|latexrelease>
 113 %<latexrelease>\EndIncludeInRelease
 114 %<latexrelease>\IncludeInRelease{0000/00/00}%
 115 %<latexrelease>                 {\setlength}{Using \setlength with \dimen0}%
 116 %<latexrelease>\def\setlength#1#2{#1#2\relax}
 117 %<latexrelease>\EndIncludeInRelease
 118 %<*2ekernel>
 119 %    \end{macrocode}
 120 % \end{macro}
 121 %
 122 % \begin{macro}{\addtolength}
 123 % |\relax| added 24 Mar 86
 124 %    \begin{macrocode}
 125 \def\addtolength#1#2{\advance#1 #2\relax}
 126 %    \end{macrocode}
 127 % \end{macro}
 128 %
 129 %
 130 % \begin{macro}{\settoheight}
 131 % \changes{LaTeX2e}{1993/11/22}{Macro added}
 132 % \begin{macro}{\settodepth}
 133 % \changes{LaTeX2e}{1993/11/22}{Macro added}
 134 % \begin{macro}{\settowidth}
 135 % \begin{macro}{\@settodim}
 136 % \changes{LaTeX2e}{1993/11/22}{Macro added}
 137 % \changes{v1.0a}{1994/03/07}{(DPC) Extra group for colour}
 138 %    The obvious analogs of |\settowidth|.
 139 %    \begin{macrocode}
 140 \def\@settodim#1#2#3{\setbox\@tempboxa\hbox{{#3}}#2#1\@tempboxa
 141 %    \end{macrocode}
 142 %    Clear the memory afterwards (which might be a lot).
 143 %    \begin{macrocode}
 144        \setbox\@tempboxa\box\voidb@x}
 145 \def\settoheight{\@settodim\ht}
 146 \def\settodepth {\@settodim\dp}
 147 \def\settowidth {\@settodim\wd}
 148 %    \end{macrocode}
 149 % \end{macro}
 150 % \end{macro}
 151 % \end{macro}
 152 % \end{macro}
 153 %
 154 %
 155 % \begin{macro}{\@settopoint}
 156 %    This macro takes the contents of the skip register that is
 157 %    supplied as its argument and removes the fractional part to make
 158 %    it a whole number of points. This can be used in class files to
 159 %    avoid values like |345.4666666pt| when calulating a dimension.
 160 % \changes{LaTeX2e}{1993/11/22}{Macro added}
 161 %    \begin{macrocode}
 162 \def\@settopoint#1{\divide#1\p@\multiply#1\p@}
 163 %</2ekernel>
 164 %    \end{macrocode}
 165 % \end{macro}
 166 %
 167 % \Finale
 168 %