Sync the type of <VariableName> with the latest email send by Larry.

[mirror_edk2.git] / Tools / XMLSchema / NamingConvention.xsd

<?xml version="1.0" encoding="UTF-8"?>\r
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" targetNamespace="http://www.TianoCore.org/2006/Edk2.0" xmlns="http://www.TianoCore.org/2006/Edk2.0">\r
    <!--\r
    Filename: NamingConvention.xsd\r
    \r
    Copyright (c) 2006, Intel Corp.\r
    All rights reserved. This program and the accompanying materials\r
    are licensed and made available under the terms and conditions of the BSD License\r
    which may be found at http://opensource.org/licenses/bsd-license.php\r
    \r
    THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
    WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
    \r
  -->\r
    <xs:annotation>\r
        <xs:documentation xml:lang="en"> This schema defines various data types and naming conventions including: base name, filename and directory naming conventions. These are all simple data types.</xs:documentation>\r
    </xs:annotation>\r
    <xs:simpleType name="BaseNameConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Base Names must start with an upper case character, followed by one or more alphanumeric characters and/or an optional underscore (_) character followed by one or more alphanumeric characters. Examples: Base_name3, BASE_NAME3, BaseName3 </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[A-Z]([a-zA-Z0-9])*(_)?([a-zA-Z0-9])*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="C_Name">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> C_Names must start with either an underscore (_) character followed by one or more alpha characters, followed by any combination of underscore or alphanumeric characters.</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="((_)*([a-zA-Z])+((_)*[a-zA-Z0-9]*))*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="DirectoryNamingConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Directory naming convention is a UNION of DOS an UNIX directory path names </xs:documentation>\r
        </xs:annotation>\r
        <xs:union memberTypes="Directory_DOS Directory_UNIX"/>\r
    </xs:simpleType>\r
    <xs:simpleType name="Directory_DOS">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Directory naming convention for Windows backslash (\) directory path name </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="([a-zA-Z]:\\)?(((\\?_*-*.*[a-zA-Z0-9]*)*(_*-*.*[a-zA-Z0-9])*)+(\\)?)*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="Directory_UNIX">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Directory naming convention for UNIX forwardslash (/) directory path name </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="(\/)?(((_*-*.*[a-zA-Z0-9]*)*(_*-*.*[a-zA-Z0-9])*)+(\/)?)*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="E-Mail">\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[a-zA-Z]+(( )*.?-?[a-zA-Z]*)*@[a-zA-Z]+(( )*.?-?[a-zA-Z]*)*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="FileNameConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> This defines what a Filename is: Alphanumeric characters and optional underscore (_) or dash (-) characters, followed by a optional dot and more alphanumeric characters. </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[a-zA-Z][a-zA-Z0-9]*((_)*(-)*(.)*[a-zA-Z0-9]*)*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="GuidArrayType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> This defines the minimum specification for a GUID Array which is 8 Hex Digits - 4 Hex Digits - 4 Hex Digits - 8 Hex Bytes, the last 16 Hex Digits can be enclosed in sqiggle {} brackets.</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="0x[a-fA-F0-9]{1,8},( )*0x[a-fA-F0-9]{1,4},( )*0x[a-fA-F0-9]{1,4}(,( )*\{)?(,?( )*0x[a-fA-F0-9]{1,2}){8}( )*(\})?"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="GuidC_NameType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> C_Names must start with either an underscore (_) character followed by one or more alpha characters, followed by any combination of underscore or alphanumeric characters.</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="((_)*([a-zA-Z])+((_)*[a-zA-Z0-9]*))*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="GuidNamingConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> A GUID must contain five different Hexadecimal character sets that are separated by a dash (-) character. </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="GuidType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> The GUID data is union of GuidNaming Convetion and GuidArrayType. </xs:documentation>\r
        </xs:annotation>\r
        <xs:union memberTypes="GuidArrayType GuidNamingConvention"/>\r
    </xs:simpleType>\r
    <xs:simpleType name="Hex64BitDataType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Define a Hex 64 Bit Value to be 0x[a-f0-9]{16}</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="(0x)?[a-fA-F0-9]{1,16}"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="HexAddressType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Define a Hex Address, 0x[a-fA-F0-9]{1,16}</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="0x[a-fA-F0-9]{1,16}"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="HexByteDataType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Define a Hex Byte Value to be 0x[a-f0-9]{2}</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="(0x)?[a-fA-F0-9]{1,2}"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="HexDataType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Define a Hex Value to be 0x[a-f0-9]+</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="0x[a-fA-F0-9]+"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="HexDigitType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Define a Hex Diget to be 0x[a-f0-9]</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[a-fA-F0-9]{1}"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="HexDoubleWordDataType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Define a Hex Double Word Value to be 0x[a-f0-9]{8}</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="0x[a-fA-F0-9]{1,8}"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="HexWordDataType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Define a Hex Word Value to be 0x[a-f0-9]{4}</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="0x[a-fA-F0-9]{1,4}"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="LibraryNameConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> This defines what a Library name is: alphanumeric characters and optional underscore (_) characters. </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[A-Z][a-zA-Z0-9]*(_*[a-zA-Z0-9])*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="NameConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">What is a name, any series of alphanumeric characters and one or more underline characters that may occur in any position</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:normalizedString">\r
            <xs:pattern value="(_*[a-zA-Z0-9]*_*)+"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="Paragraph">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">This describes the normal text of a paragraph that can be used in a license or description tag.</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:normalizedString"/>\r
    </xs:simpleType>\r
    <xs:simpleType name="PathAndFilename">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Naming convention for a path and file name</xs:documentation>\r
        </xs:annotation>\r
        <xs:union memberTypes="Directory_DOS Directory_UNIX"/>\r
    </xs:simpleType>\r
    <xs:simpleType name="PlatformNamingConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> This defines what a Platform Name is: Alphanumeric characters and optional underscore (_) or dash (-) characters, followed by a dot and more alphanumeric characters. </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:NCName">\r
            <xs:pattern value="(([a-zA-Z][a-zA-Z0-9]*)(_)*(.)*)+"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="Polarity">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Limit Polarity vaild values to -1, 0 and 1</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:int">\r
            <xs:pattern value="-1|0|1"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="Sentence">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> This data type requires two or more words </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:normalizedString">\r
            <xs:pattern value="(\w+\W*)+( )+(\W*\w*\W*\s*)*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="ToolNameConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> This defines what a Tool name is: Alphanumeric characters and optional underscore (_) or dash (-) characters, optionally followed by a dot and more alphanumeric characters. </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[a-zA-Z][a-zA-Z0-9]*(_*-*.*[a-zA-Z0-9])*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="UCLetterType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Definition of a UpperCase Letter type, which can be any combination of upper case characters followed by zero or more underscore and/or uppercase alphanumeric characters </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[A-Z]{1}"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="UCNameType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Definition of a UpperCase Name, which can be any combination of upper case characters followed by zero or more underscore and/or uppercase alphanumeric characters </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[A-Z]+(_*[A-Z0-9]*( )*)*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="UserName">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Specify a User Name</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="[a-zA-Z]+(( )*.?-?[a-zA-Z]*)*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="V1">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">%VAR%(Directory)*(File_Names)*</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="((%[A-Z](_*[A-Z0-9]*)*%)+((((\\)?_*-*.*[a-zA-Z0-9]*)*(_*-*.*[a-zA-Z0-9])*)+(\\)?)*)"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="V2">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">($VAR | $( VAR) | ${VAR})(Directory)*(File_Names)</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="(($[A-Z](_*[A-Z0-9]*)*)+||($\([A-Z](_*[A-Z0-9]*)*\))+||($\{[A-Z](_*[A-Z0-9]*)*\})+)+(\/)?(((((_*-*.*[a-zA-Z0-9]*)*(_*-*.*[a-zA-Z0-9])*)+(\/)?)*)*)"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="VariableConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">VariableConvention is a UNION of: $VAR, $( VAR), ${VAR} and %VAR% and Directory and File Names</xs:documentation>\r
        </xs:annotation>\r
        <xs:union memberTypes="V1 V2"/>\r
    </xs:simpleType>\r
    <xs:simpleType name="VariableGuidType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> The GUID data is union of GuidNaming Convetion and GuidArrayType. </xs:documentation>\r
        </xs:annotation>\r
        <xs:union memberTypes="GuidArrayType GuidNamingConvention Zero"/>\r
    </xs:simpleType>\r
    <xs:simpleType name="VariableNamingConvention">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">VariableConvention is a UNION of: $VAR, $( VAR), ${VAR} and %VAR%</xs:documentation>\r
        </xs:annotation>\r
        <xs:union memberTypes="Variable_DOS Variable_UNIX Variable_UNIX_Scope1 Variable_UNIX_Scope2"/>\r
    </xs:simpleType>\r
    <xs:simpleType name="Variable_DOS">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Definition of a DOS Variable Name: %VAR% It must start with an Upper Case character.</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="%[A-Z](_*[A-Z0-9]*)*%"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="Variable_UNIX">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Definition of a UNIX Variable Name: $VAR It must start with an Upper Case character.</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="$[A-Z](_*[A-Z0-9]*)*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="Variable_UNIX_Scope1">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Definition of a UNIX Variable Name: $( VAR1) It must start with an Upper Case character.</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="$\([A-Z](_*[A-Z0-9]*)*\)"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="Variable_UNIX_Scope2">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Definition of a UNIX Variable Name: ${ VAR1} It must start with an Upper Case character.</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="$\{[A-Z](_*[A-Z0-9]*)*\}"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="VersionDataType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Definition of a Version Number, which can be any combination of a number followed by zero or more alphanumeric-dot-alphanumeric characters </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="xs:normalizedString"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="Zero">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en">Define Zero as a vaild value</xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:int">\r
            <xs:pattern value="0"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
    <xs:simpleType name="OldVersionDataType">\r
        <xs:annotation>\r
            <xs:documentation xml:lang="en"> Definition of a Version Number, which can be any combination of a number followed by zero or more alphanumeric-dot-alphanumeric characters </xs:documentation>\r
        </xs:annotation>\r
        <xs:restriction base="xs:string">\r
            <xs:pattern value="([0-9])+[a-zA-Z0-9]*(-?.?([a-zA-Z0-9])*)*"/>\r
        </xs:restriction>\r
    </xs:simpleType>\r
</xs:schema>\r