1. Manuals
  2. Tumbleweed
  3. tcllib
  4. valtype_common(n)

Scroll to navigation

valtype::common(n) Validation types valtype::common(n) 





NAME


valtype::common - Validation, common code






SYNOPSIS


package require Tcl 8.5


package require valtype::common ?1?


valtype::common::reject code text


valtype::common::badchar code ?text?


valtype::common::badcheck code ?text?


valtype::common::badlength code lengths
    ?text?


valtype::common::badprefix code prefixes
    ?text?










DESCRIPTION


This package implements a number of common commands used by the
    validation types in this module. These commands essentially encapsulate the
    throwing of validation errors, ensuring that a proper -errorcode is
    used. See section Error Codes.






API



  

  
The core command of this package it throws an INVALID error with
      the specified text. The first argument is a list of codes extending
      the INVALID with detail information.

  

  
This command throws an INVALID CHAR error with the specified
      text. The first argument is a list of codes providing details.
      These are inserted between the codes INVALID and
    CHARACTER.

  

  
This command throws an INVALID CHECK-DIGIT error with the specified
      text, if any, extended by the standard text "the check digit
      is incorrect". The first argument is a list of codes providing
      details. These are inserted between the codes INVALID and
      CHECK_DIGIT.

  

  
This command throws an INVALID LENGTH error with the specified
      text, if any, extended by the standard text "incorrect length,
      expected ... character(s)". The first argument is a list of codes
      providing details. These are inserted between the codes INVALID and
      LENGTH. The argument lengths is a list of the input lengths
      which had been expected, i.e. these are the valid lengths.

  

  
This command throws an INVALID PREFIX error with the specified
      text, if any, extended by the standard text "incorrect prefix,
      expected ...". The first argument is a list of codes providing
      details. These are inserted between the codes INVALID and
      PREFIX. The argument prefixes is a list of the input
      prefixes which had been expected, i.e. these are the valid prefixes.








ERROR CODES


The errors thrown by the commands of this package all use the
    -errorcode INVALID to distinguish the input validation
    failures they represent from package internal errors.


To provide more detailed information about why the validation
    failed the -errorCode goes actually beyond that. First, it will
    contain a code detailing the type itself. This is supplied by the caller.
    This is then followed by values detailing the reason for the failure. The
    full set of -errorCodes which can be thrown by this package are shown
    below, with <> a placeholder for both the caller-supplied
    type-information, the type description.



  

  
The input value contained one or more bad characters, i.e. characters
      which must not occur in the input for it to be a <>.

  

  
The check digit of the input value is wrong. This usually signals a
      data-entry error, with digits transposed, forgotten, etc. Of course, th
      input may be an outright fake too.

  

  
The input value is of the wrong length to be a <>.

  

  
The input value does not start with the magic value(s) required for it to
      be a <>.








BUGS, IDEAS, FEEDBACK


This document, and the package it describes, will undoubtedly
    contain bugs and other problems. Please report such in the category
    valtype of the Tcllib Trackers
    [http://core.tcl.tk/tcllib/reportlist]. Please also report any ideas for
    enhancements you may have for either package and/or documentation.


When proposing code changes, please provide unified diffs,
    i.e the output of diff -u.


Note further that attachments are strongly preferred over
    inlined patches. Attachments can be made by going to the Edit form of
    the ticket immediately after its creation, and then using the left-most
    button in the secondary navigation bar.






KEYWORDS


Checking, Testing, Type checking, Validation, Value checking,
  isA






CATEGORY


Validation, Type checking






COPYRIGHT


Copyright (c) 2011 Andreas Kupries <andreas_kupries@users.sourceforge.net>








  

    1
    tcllib