ben
/
mwparserfromhell
mirror of https://github.com/earwig/mwparserfromhell
1
1
Fork 0
Code Releases 24 Activity
A Python parser for MediaWiki wikicode https://mwparserfromhell.readthedocs.io/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
104 Commits
1 Branch
8.9 MiB
 
 
 
 
Tree: 1caeb2d570
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1caeb2d570'
${ noResults }
mwparserfromhell/mwparserfromhell/parser/contexts.py

77 lines
2.9 KiB
Raw Blame History 

  1. # -*- coding: utf-8  -*-

  2. #

  3. # Copyright (C) 2012 Ben Kurtovic <ben.kurtovic@verizon.net>

  4. #

  5. # Permission is hereby granted, free of charge, to any person obtaining a copy

  6. # of this software and associated documentation files (the "Software"), to deal

  7. # in the Software without restriction, including without limitation the rights

  8. # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

  9. # copies of the Software, and to permit persons to whom the Software is

  10. # furnished to do so, subject to the following conditions:

  11. #

  12. # The above copyright notice and this permission notice shall be included in

  13. # all copies or substantial portions of the Software.

  14. #

  15. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

  16. # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

  17. # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

  18. # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

  19. # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

  20. # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

  21. # SOFTWARE.

  22. 

  23. """

  24. This module contains various "context" definitions, which are essentially flags

  25. set during the tokenization process, either on the current parse stack (local

  26. contexts) or affecting all stacks (global contexts). They represent the context

  27. the tokenizer is in, such as inside a template's name definition, or inside a

  28. level-two heading. This is used to determine what tokens are valid at the

  29. current point and also if the current parsing route is invalid.

  30. 

  31. The tokenizer stores context as an integer, with these definitions bitwise OR'd

  32. to set them, AND'd to check if they're set, and XOR'd to unset them. The

  33. advantage of this is that contexts can have sub-contexts (as ``FOO == 0b11``

  34. will cover ``BAR == 0b10`` and ``BAZ == 0b01``).

  35. 

  36. Local (stack-specific) contexts:

  37. 

  38. * :py:const:`TEMPLATE` (``0b000000111``)

  39. 

  40.     * :py:const:`TEMPLATE_NAME` (``0b000000001``)

  41.     * :py:const:`TEMPLATE_PARAM_KEY` (``0b000000010``)

  42.     * :py:const:`TEMPLATE_PARAM_VALUE` (``0b000000100``)

  43. 

  44. * :py:const:`HEADING` (``0b111111000``)

  45. 

  46.     * :py:const:`HEADING_LEVEL_1` (``0b000001000``)

  47.     * :py:const:`HEADING_LEVEL_2` (``0b000010000``)

  48.     * :py:const:`HEADING_LEVEL_3` (``0b000100000``)

  49.     * :py:const:`HEADING_LEVEL_4` (``0b001000000``)

  50.     * :py:const:`HEADING_LEVEL_5` (``0b010000000``)

  51.     * :py:const:`HEADING_LEVEL_6` (``0b100000000``)

  52. 

  53. Global contexts:

  54. 

  55. * :py:const:`GL_HEADING` (``0b1``)

  56. """

  57. 

  58. # Local contexts:

  59. 

  60. TEMPLATE =              0b000000111

  61. TEMPLATE_NAME =         0b000000001

  62. TEMPLATE_PARAM_KEY =    0b000000010

  63. TEMPLATE_PARAM_VALUE =  0b000000100

  64. 

  65. HEADING =               0b111111000

  66. HEADING_LEVEL_1 =       0b000001000

  67. HEADING_LEVEL_2 =       0b000010000

  68. HEADING_LEVEL_3 =       0b000100000

  69. HEADING_LEVEL_4 =       0b001000000

  70. HEADING_LEVEL_5 =       0b010000000

  71. HEADING_LEVEL_6 =       0b100000000

  72. 

  73. 

  74. # Global contexts:

  75. 

  76. GL_HEADING = 0b1