├── .gitignore
├── indent
    └── moose_fw.vim
├── ftplugin
    └── moose_fw
    │   ├── insert_pairs.vim
    │   ├── sections.vim
    │   └── commenting.vim
├── plugin
    └── moose_fw.vim
├── autoload
    └── moose_fw
    │   ├── sections.vim
    │   ├── detect.vim
    │   ├── insert_pairs.vim
    │   ├── tabs.vim
    │   └── commenting.vim
├── ftdetect
    └── moose_fw.vim
├── syntax
    └── moose_fw.vim
├── README.md
├── doc
    └── moose_fw.txt
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | tags
2 | tags-ja
3 | 


--------------------------------------------------------------------------------
/indent/moose_fw.vim:
--------------------------------------------------------------------------------
 1 | " Indent file for MOOSE framwork input file
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | if exists("b:did_indent")
 5 |     finish
 6 | endif
 7 | let b:did_indent = 1
 8 | 
 9 | " Set values associated with indenting
10 | setlocal indentexpr=moose_fw#tabs#GetMOOSEfwIndent(v:lnum)
11 | setlocal indentkeys=!^F,o,O,]
12 | 


--------------------------------------------------------------------------------
/ftplugin/moose_fw/insert_pairs.vim:
--------------------------------------------------------------------------------
 1 | " Vim section movement file for MOOSE framework input files.
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | " Similar to indent code but for placing closing block items
 5 | " Check if wanted or not
 6 | if exists("g:moo_fw_no_insert_pairs") || exists("b:did_insert_pairs")
 7 |     finish
 8 | endif
 9 | let b:did_insert_pairs = 1
10 | 
11 | " So it begins
12 | inoremap <script> <buffer> <silent> ] <C-O>:call moose_fw#insert_pairs#CloseGetPot()<CR>
13 | 


--------------------------------------------------------------------------------
/plugin/moose_fw.vim:
--------------------------------------------------------------------------------
 1 | " Vim constant variables for MOOSE framework input files.
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | " The goal is to load variables once and never change them. Then if future
 5 | " development changes occur, this will be the only place the variable
 6 | " definition needs to be change instead of in every file location as has been
 7 | " done previously.
 8 | 
 9 | " Top Block Definitions
10 | let g:moose_fw_variables_topstart = '\v^\[(\w|\-)*\w\]'
11 | let g:moose_fw_variables_topend = '\v^\[\]'
12 | "  for tests, examples, or assessments
13 | let g:moose_fw_test_topstart = '\v^\[Tests\]'
14 | 
15 | " Sub-block Definitions
16 | let g:moose_fw_variables_substart = '\v\[\.\/(\w|\-|\*|\<|\>)*\]'
17 | let g:moose_fw_variables_subend = '\v\[\.\.\/\]'
18 | 
19 | " Comments
20 | let g:moose_fw_variables_comment = '\v\#.*$'
21 | let g:moose_fw_variables_onlycomment = '\v^\s*\#.*$'
22 | 
23 | " New MOOSE block definitions
24 | let g:moose_fw_variables_newtop = '\v\[(\w|\-|\/)*\w\]'
25 | let g:moose_fw_variables_newend = '\v\[\]'
26 | 


--------------------------------------------------------------------------------
/autoload/moose_fw/sections.vim:
--------------------------------------------------------------------------------
 1 | " Autoload functions for ftplugin/moose_fw/sections.vim.
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | " Borrowed from 'Learn Vimscript the Hard Way'
 5 | " Function to move section
 6 | function! moose_fw#sections#Move2Section(visual, direction, type)
 7 |     if a:visual
 8 |         normal! gv
 9 |     endif
10 | 
11 |     if a:direction
12 |         let dir = '?'
13 |         let flags = 'e'
14 |     else
15 |         let dir = '/'
16 |         let flags = ''
17 |     endif
18 | 
19 |     if a:type
20 |         " Opening Section
21 |         let pattern = '\v(' . g:moose_fw_variables_topstart[2:] . ')|('
22 |             \ . g:moose_fw_variables_substart[2:] . ')|('
23 |             \ . g:moose_fw_variables_newtop[2:] . ')'
24 |     else
25 |         " Closing Section
26 |         let pattern = '\v(' . g:moose_fw_variables_topend[2:] . ')|('
27 |             \ . g:moose_fw_variables_subend[2:] . ')|('
28 |             \ . g:moose_fw_variables_newend[2:] . ')'
29 |     endif
30 | 
31 |     execute 'silent normal! ' . dir . pattern . dir . flags . "\r"
32 | endfunction
33 | 


--------------------------------------------------------------------------------
/ftplugin/moose_fw/sections.vim:
--------------------------------------------------------------------------------
 1 | " Vim section movement file for MOOSE framework input files.
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | " Mapping Section Movement Commands (Press them quickly together.)
 5 | " Search towards end for closing section
 6 | noremap <script> <buffer> <silent> ]] :call moose_fw#sections#Move2Section(0, 0, 0)<CR>
 7 | vnoremap <script> <buffer> <silent> ]] :<C-U>call moose_fw#sections#Move2Section(1, 0, 0)<CR>
 8 | " Search towards end for opening section
 9 | noremap <script> <buffer> <silent> ][ :call moose_fw#sections#Move2Section(0, 0, 1)<CR>
10 | vnoremap <script> <buffer> <silent> ][ :<C-U>call moose_fw#sections#Move2Section(1, 0, 1)<CR>
11 | " Search towards beginning for closing section
12 | noremap <script> <buffer> <silent> [] :call moose_fw#sections#Move2Section(0, 1, 0)<CR>
13 | vnoremap <script> <buffer> <silent> [] :<C-U>call moose_fw#sections#Move2Section(1, 1, 0)<CR>
14 | " Search towards beginning for opening section
15 | noremap <script> <buffer> <silent> [[ :call moose_fw#sections#Move2Section(0, 1, 1)<CR>
16 | vnoremap <script> <buffer> <silent> [[ :<C-U>call moose_fw#sections#Move2Section(1, 1, 1)<CR>
17 | 


--------------------------------------------------------------------------------
/ftdetect/moose_fw.vim:
--------------------------------------------------------------------------------
 1 | " Vim file to detect MOOSE framework input files.
 2 | " Languages: MOOSE Framework input
 3 | 
 4 | " Detect file based on extension
 5 | " Common input extension is .i which collides with many others
 6 | if !exists('g:moo_fw_extensions')
 7 |     let g:moo_fw_extensions = ["i"]
 8 | endif
 9 | if index(g:moo_fw_extensions, "i") >= 0
10 |     let g:filetype_i="moose_fw" " Take care of collisions
11 | endif
12 | augroup moo_fw_auto_ext
13 |     autocmd!
14 |     if len(g:moo_fw_extensions) > 0
15 |         execute 'autocmd BufRead,BufNewFile *.'
16 |             \ . join(g:moo_fw_extensions, ',*.') . ' setfiletype moose_fw'
17 |     endif
18 | augroup END
19 | 
20 | " NOTE: A modeline could also be used to set the filetype for any extension.
21 | " To use modelines, put this line at the start or end of your MOOSE input file.
22 | " Remove the quotation mark and space (" ):
23 | " # vi:filetype=moose_fw
24 | " IMPORTANT: The space between # and vi is required.
25 | 
26 | augroup moo_fw_autodetect
27 |     autocmd!
28 |     if !exists('g:moo_fw_search_file_disable')
29 |         autocmd BufEnter,BufWinEnter * call moose_fw#detect#CheckMOOSEfwInput()
30 |     endif
31 | augroup END
32 | 


--------------------------------------------------------------------------------
/ftplugin/moose_fw/commenting.vim:
--------------------------------------------------------------------------------
 1 | " Allow for easier method to comment blocks of MOOSE framework input files.
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | if exists("g:moo_fw_no_commenting") || exists("b:did_commenting")
 5 |     finish
 6 | endif
 7 | let b:did_commenting = 1
 8 | 
 9 | " Mapping add comment and delete comments (not in operator pending mode)
10 | nnoremap <script> <buffer> <silent> <Leader>c :<C-U>call moose_fw#commenting#CommentAtIndent(v:count1, 0)<CR>
11 | vnoremap <script> <buffer> <silent> <Leader>c :call moose_fw#commenting#CommentAtIndent(v:count1, 0)<CR>gv
12 | 
13 | nnoremap <script> <buffer> <silent> <Leader>x :<C-U>call moose_fw#commenting#RemovePlacedComment(v:count1, 0)<CR>
14 | vnoremap <script> <buffer> <silent> <Leader>x :call moose_fw#commenting#RemovePlacedComment(v:count1, 0)<CR>gv
15 | 
16 | nnoremap <script> <buffer> <silent> <Leader>C :<C-U>call moose_fw#commenting#CommentAtIndent(v:count1, 1)<CR>
17 | vnoremap <script> <buffer> <silent> <Leader>C :call moose_fw#commenting#CommentAtIndent(v:count1, 1)<CR>gv
18 | 
19 | nnoremap <script> <buffer> <silent> <Leader>X :<C-U>call moose_fw#commenting#RemovePlacedComment(v:count1, 1)<CR>
20 | vnoremap <script> <buffer> <silent> <Leader>X :call moose_fw#commenting#RemovePlacedComment(v:count1, 1)<CR>gv
21 | 


--------------------------------------------------------------------------------
/autoload/moose_fw/detect.vim:
--------------------------------------------------------------------------------
 1 | " Autoload functions for ftdetect/moose_fw.vim.
 2 | " Languages: MOOSE Framework input
 3 | 
 4 | " Detect file based on if contains a [Opener] and [] closer block.
 5 | "   let g:moo_fw_search_lines = 'smaller number' variable if loading files
 6 | "   becomes slow.
 7 | function! moose_fw#detect#CheckMOOSEfwInput()
 8 |     if &filetype ==? "moose_fw"
 9 |         return
10 |     endif
11 |     " Check certain number of lines
12 |     if !exists('g:moo_fw_search_lines')
13 |         let g:moo_fw_search_lines = 50
14 |     endif
15 |     let check_lines = g:moo_fw_search_lines
16 |     let c = 1
17 |     while c <= check_lines
18 |         if getline(c) =~? g:moose_fw_variables_topstart
19 |             " Check if a test opener
20 |             if getline(c) =~? g:moose_fw_test_topstart
21 |                 setfiletype moose_fw
22 |                 return
23 |             endif
24 |             " Found a non-test opener
25 |             let sub = 1
26 |             while sub <= check_lines
27 |                 if getline(c + sub) =~? g:moose_fw_variables_topend
28 |                     setfiletype moose_fw
29 |                     let sub += check_lines
30 |                     let c += check_lines
31 |                 endif
32 |                 let sub += 1
33 |             endwhile
34 |         endif
35 |         let c += 1
36 |     endwhile
37 | endfunction
38 | 


--------------------------------------------------------------------------------
/autoload/moose_fw/insert_pairs.vim:
--------------------------------------------------------------------------------
 1 | " Autoload functions for ftplugin/moose_fw/insert_pairs.vim.
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | " Save cursor position to get back to it
 5 | function! s:SavePosition()
 6 |     return 'call cursor('.line('.').','. col('.'). ')'
 7 | endfunction
 8 | 
 9 | " Function to check if closing pair is needed
10 | function! s:NeedClosingPair()
11 |     let l:typecloser = 'NULL'
12 |     let l:linestring = getline('.')
13 |     " Skip if part of comment
14 |     if l:linestring !~? g:moose_fw_variables_comment
15 |         " Check which one if any is needed
16 |         if l:linestring =~? g:moose_fw_variables_topstart
17 |             let l:typecloser = '[]'
18 |         elseif l:linestring =~? g:moose_fw_variables_newtop
19 |             let l:typecloser = '[]'
20 |         elseif l:linestring =~? g:moose_fw_variables_substart
21 |             let l:typecloser = '[../]'
22 |         else
23 |             let l:typecloser = 'UNKNOWN'
24 |         endif
25 |     else
26 |         let l:typecloser = 'COMMENT'
27 |     endif
28 |     return l:typecloser
29 | endfunction
30 | 
31 | " Main function to close block section
32 | function! moose_fw#insert_pairs#CloseGetPot()
33 |     " No Beep
34 |     if col('.') == col('$') - 1
35 |         " For at end of line
36 |         execute 'silent normal! A]'
37 |     else
38 |         " For inbetween
39 |         execute 'silent normal! i]'
40 |         normal l
41 |     endif
42 |     " Get current cursor position
43 |     let l:restore = s:SavePosition()
44 |     let l:closer = s:NeedClosingPair()
45 |     if l:closer !=# 'COMMENT' && l:closer !=# 'UNKNOWN' && l:closer !=# 'NULL'
46 |         " We can place a closer on the next line down
47 |         execute 'silent normal! o' . l:closer . "\<ESC>"
48 |         execute l:restore
49 |         startinsert!
50 |     endif
51 | endfunction
52 | 


--------------------------------------------------------------------------------
/autoload/moose_fw/tabs.vim:
--------------------------------------------------------------------------------
 1 | " Autoload functions for indent/moose_fw.vim.
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | " Much of this code was borrowed from pascal.vim
 5 | 
 6 | "" Functions for indenting correctly
 7 | " Check previous line's indentation
 8 | function! s:GetPrevNonCommentLineNum( line_num )
 9 |     " Skip lines with only a comment
10 |     let nline = a:line_num
11 |     while nline > 0
12 |         let nline = prevnonblank(nline-1)
13 |         if getline(nline) !~? g:moose_fw_variables_onlycomment
14 |             break
15 |         endif
16 |     endwhile
17 |     return nline
18 | endfunction
19 | 
20 | " Main function for indenting
21 | function! moose_fw#tabs#GetMOOSEfwIndent( line_num )
22 |     " Probably should not start indented
23 |     if a:line_num == 0
24 |         return 0
25 |     endif
26 |     " Let others get our value for any line
27 |     let this_codeline = getline( a:line_num )
28 |     if this_codeline =~? g:moose_fw_variables_onlycomment
29 |         return indent( a:line_num )
30 |     endif
31 | 
32 |     " Get indentation of previous line
33 |     let prev_codeline_num = s:GetPrevNonCommentLineNum( a:line_num )
34 |     let prev_codeline = getline( prev_codeline_num )
35 |     let indnt = indent( prev_codeline_num )
36 | 
37 |     " Begin the definitions of keywords for indent changing
38 |     "   Order does matter; put prev_codeline before this_codeline
39 |     " Top Opener (such as [Kernels] )
40 |     if prev_codeline =~? g:moose_fw_variables_topstart ||
41 |                 \ prev_codeline =~? g:moose_fw_variables_newtop
42 |         let indnt += &shiftwidth
43 |     endif
44 | 
45 |     " Sub Opener (such as [./sub] )
46 |     if prev_codeline =~? g:moose_fw_variables_substart
47 |         let indnt += &shiftwidth
48 |     endif
49 | 
50 |     " Single or double quote without matching pair ( ' " )
51 |     if prev_codeline =~? '\v(\=\s*'')|(\=\s*")' &&
52 |                 \ prev_codeline !~? '\v(''.*'')|(".*")'
53 |         let indnt = match( prev_codeline, '\v('')|(")' ) + 1
54 |     endif
55 | 
56 |     " Single or double quote closer without matching open
57 |     if prev_codeline =~? '\v('')|(")' &&
58 |                 \ prev_codeline !~? '\v(''.*'')|(".*")' &&
59 |                 \ prev_codeline !~? '\v(\=\s*'')|(\=\s*")'
60 |         " Need to find previous indent of '=' line
61 |         let qline = a:line_num
62 |         while qline > 0
63 |             let qline = prevnonblank( qline - 1 )
64 |             if getline(qline) =~? '\v(\=\s*'')|(\=\s*")'
65 |                 let indnt = indent( qline )
66 |                 break
67 |             endif
68 |         endwhile
69 |     endif
70 | 
71 |     " Top Closer [] (When not at beginning)
72 |     if this_codeline =~? g:moose_fw_variables_topend[3:]
73 |         let indnt -= &shiftwidth
74 |     endif
75 | 
76 |     " Sub Closer [../]
77 |     if this_codeline =~? g:moose_fw_variables_subend
78 |         let indnt -= &shiftwidth
79 |     endif
80 | 
81 |     " Return the net indent modification
82 |     return indnt
83 | endfunction
84 | 


--------------------------------------------------------------------------------
/autoload/moose_fw/commenting.vim:
--------------------------------------------------------------------------------
 1 | " Autoload functions for ftplugin/moose_fw/commenting.vim.
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | " Function to find column to place # in
 5 | function! s:SavedColumn(direction)
 6 |     let l:orig_pos = 'call cursor('.line('.').','. col('.'). ')'
 7 |     " Check previous or post line for comment
 8 |     if a:direction
 9 |         " Look down cause going up
10 |         if getline(nextnonblank(line('.')+1)) =~? '\v^\s*\#'
11 |             " Next line has only a comment on it
12 |             execute 'call cursor(' . nextnonblank(line('.')+1) . ',0)'
13 |         endif
14 |     else
15 |         " Look up cause going down
16 |         if getline(prevnonblank(line('.')-1)) =~? '\v^\s*\#'
17 |             " Previous line has only a comment on it
18 |             execute 'call cursor(' . prevnonblank(line('.')-1) . ',0)'
19 |         endif
20 |     endif
21 |     " Find column to place '#' on
22 |     if getline('.') =~? '\v^\s'
23 |         execute 'silent normal! 0w'
24 |         let l:tempcol = col('.')
25 |     else
26 |         let l:tempcol = 1
27 |     endif
28 |     execute l:orig_pos
29 |     return l:tempcol
30 | endfunction
31 | 
32 | " Function to loop and place comments at specific column
33 | function! moose_fw#commenting#CommentAtIndent(num_count, direction)
34 |     let l:comcol = s:SavedColumn(a:direction)
35 |     let l:lesscom = l:comcol - 1 " Not in while loop
36 |     let l:i_c = 0
37 |     while l:i_c != a:num_count
38 |         let l:i_c += 1
39 |         if getline('.') =~? '\v^$'
40 |             " Treat blank lines special since need end of line
41 |             if l:comcol > 1
42 |                 execute 'silent normal! ' . l:lesscom . 'i ' . "\<ESC>"
43 |             endif
44 |             execute 'silent normal! A#' . "\<ESC>"
45 |         else
46 |             if getline('.') =~? '\v^\s'
47 |                 execute 'silent normal! 0w'
48 |                 if l:comcol < col('.')
49 |                     execute 'silent normal! ' . l:comcol . '|'
50 |                 endif
51 |             else
52 |                 execute 'silent normal! 0'
53 |             endif
54 |             execute 'silent normal! i#' . "\<ESC>"
55 |         endif
56 |         if a:direction
57 |             execute 'silent normal! k'
58 |         else
59 |             execute 'silent normal! j'
60 |         endif
61 |     endwhile
62 | endfunction
63 | 
64 | " Function to loop and remove comment at beginning of line
65 | function! moose_fw#commenting#RemovePlacedComment(num_count, direction)
66 |     let l:i_c = 0
67 |     while l:i_c != a:num_count
68 |         let l:i_c += 1
69 |         if getline('.') =~? '\v^\s+\#$'
70 |             " Has hanging alone '#'
71 |             execute 'silent normal! 0d$'
72 |         elseif getline('.') =~? '\v^\#'
73 |             " Begins line with '#'
74 |             execute 'silent normal! 0x'
75 |         elseif getline('.') =~? '\v^\s+\#\s*\S.*$'
76 |             " space and then comment with space or no space but stuff after it
77 |             execute 'silent normal! 0wx'
78 |         endif
79 |         if a:direction
80 |             execute 'silent normal! k'
81 |         else
82 |             execute 'silent normal! j'
83 |         endif
84 |     endwhile
85 | endfunction
86 | 


--------------------------------------------------------------------------------
/syntax/moose_fw.vim:
--------------------------------------------------------------------------------
 1 | " Vim syntax file for MOOSE framework input files.
 2 | " Language: MOOSE Framework input file
 3 | 
 4 | if exists("b:current_syntax")
 5 |     finish
 6 | endif
 7 | 
 8 | "" Number Matching
 9 | " Integer with - + or nothing in front and not part of a word
10 | syn match mooInteger "\v\w@<!\d+\w@!" display
11 | syn match mooInteger "\v\w@<![-+]\d+\w@!" display
12 | 
13 | " Floating point number with decimal no E or e
14 | syn match mooFloat "\v\d+\.\d*" display
15 | syn match mooFloat "\v[-+]\d+\.\d*" display
16 | 
17 | " Floating point like number with E and no decimal point (+,-)
18 | syn match mooFloat "\v[-+]=\d[[:digit:]]*[eE][-+]=\d+" display
19 | syn match mooFloat "\v\d[[:digit:]]*[eE][-+]=\d+" display
20 | 
21 | " Floating point like number with E and decimal point (+,-)
22 | syn match mooFloat "\v[-+]=\d[[:digit:]]*\.\d*[eE][-+]=\d+" display
23 | syn match mooFloat "\v\d[[:digit:]]*\.\d*[eE][-+]=\d+" display
24 | 
25 | " Boolean Matching
26 | syn keyword mooBoolean true false
27 | 
28 | " Todo's and Notes and Comments
29 | syn keyword mooTodo contained TODO todo Todo FIXME fixme Fixme NOTE Note note
30 | execute 'syn match mooComment "' . g:moose_fw_variables_comment . '" contains=mooTodo'
31 | 
32 | "" Keyword Matching
33 | " Define block regions
34 | execute 'syn region mooTopBlock start="' . g:moose_fw_variables_topstart . '" end="'
35 |     \ . g:moose_fw_variables_topend . '" fold contains=ALLBUT,mooTodo,mooSubWord'
36 | execute 'syn region newmooTopBlock start="' . g:moose_fw_variables_newtop . '" end="'
37 |     \ . g:moose_fw_variables_newend . '" fold contains=ALLBUT,mooTodo,mooSubWord,mooTopBlock'
38 | execute 'syn region mooSubBlock matchgroup=mooSubWord start="' . g:moose_fw_variables_substart
39 |     \ . '" end="' . g:moose_fw_variables_subend . '" fold transparent contained contains=ALLBUT,mooTodo,mooTopBlock,mooTopWord,mooSubWord'
40 | syn sync fromstart
41 | 
42 | " Many of the following matches are borrowed from Daniel Schwen's Atom files.
43 | " Thanks Daniel! :D
44 | syn match mooTopWord "\v(\[)(Adaptivity|Bounds|DomainIntegral|Mesh|MeshModifiers|Modules|Kernels|AuxKernels|ScalarKernels|NodalKernels|AuxScalarKernels|Variables|AuxVariables|Materials|Postprocessors|BCs|ICs|InterfaceKernels|Executioner|Outputs|Problem|Splits|Debug|Preconditioning|UserObjects|Functions|GlobalParams|VectorPostprocessors|Dampers|DiracKernels|DGKernels|Constraints|NodalNormals|CoupledProblems|DeprecatedBlock|MultiApps|Transfers|XFEM|PerformanceMetricOutputs)(\]|\/)" contained
45 | syn keyword mooControl contained TimeStepper TimePeriods Quadrature Predictor Adaptivity Indicators Markers Periodic InitialCondition MortarInterfaces
46 | syn keyword mooOrder contained CONSTANT FIRST SECOND THIRD FOURTH FIFTH SIXTH SEVENTH EIGHTH NINTH
47 | syn keyword mooQuad contained LAGRANGE MONOMIAL HERMITE SCALAR HIERARCHIC CLOUGH XYZ SZABAB BERNSTEIN L2_LAGRANGE L2_HIERARCHIC
48 | syn keyword mooElem contained EDGE EDGE2 EDGE3 EDGE4 QUAD QUAD4 QUAD8 QUAD9 TRI3 TRI6 HEX HEX8 HEX20 HEX27 TET4 TET10 PRISM6 PRISM15 PRISM18
49 | syn keyword mooWhen contained none initial linear nonlinear timestep_end timestep_begin final failed custom
50 | syn keyword mooOper contained abs acos acosh arg asin atan atan2 atanh cbrt ceil conj cos cosh cot csc exp exp2 floor hypot if imag int log log10 log2 max min polar pow real sec sin sinh sqrt tan tanh trunc plog
51 | 
52 | " MOOSE escape characters
53 | syn match mooEscape "\v\\." display
54 | 
55 | " MOOSE strings
56 | syn match mooString "\v(\').*(\1)"
57 | 
58 | " MOOSE type helps spot what a block or sub-block is about
59 | syn match mooType "\v<type((\s|\t)+)*\=" contained
60 | syn match mooActive "\v<active((\s|\t)+)*\=" contained
61 | syn match mooBlock "\v<block((\s|\t)+)*\=" contained
62 | syn match mooBound "\v<boundary((\s|\t)+)*\=" contained
63 | 
64 | " MOOSE sub-block words can be anything.
65 | execute 'syn match mooSubWord "' . g:moose_fw_variables_substart . '" contained'
66 | 
67 | "" Highlighting Links
68 | " Set the script has run
69 | let b:current_syntax = "moose_fw"
70 | 
71 | " Definitions
72 | hi def link mooInteger      Number
73 | hi def link mooFloat        Float
74 | hi def link mooBoolean      Boolean
75 | hi def link mooTodo         Todo
76 | hi def link mooComment      Comment
77 | hi def link mooTopWord      Label
78 | hi def link mooControl      Keyword
79 | hi def link mooOrder        Keyword
80 | hi def link mooQuad         Keyword
81 | hi def link mooElem         Tag
82 | hi def link mooWhen         Keyword
83 | hi def link mooOper         Operator
84 | hi def link mooEscape       VisualNOS
85 | hi def link mooString       String
86 | hi def link mooType         Type
87 | hi def link mooBlock        Type
88 | hi def link mooBound        Type
89 | hi def link mooActive       WarningMsg
90 | hi def link mooSubWord      Identifier
91 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | ## INTRODUCTION
  2 | ---
  3 | To help make writing [MOOSE](http://mooseframework.org/) input files easier on
  4 | a common editor found on almost all remote computation resources, I want to
  5 | make a Vim plugin that does the style right, highlights keywords, does folding,
  6 | and does section movement correctly. Vim style documentation also included and
  7 | accessed by `:help moose_fw`.
  8 | 
  9 | ## INSTALLING
 10 | ---
 11 | ### Manual Method
 12 | Inside the user's home Vim directory (on Linux `.vim`) copy the contents of
 13 | each subdirectory into the corresponding subdirectory. If a subdirectory does
 14 | not exist then create that subdirectory. Ensure that syntax, indentation, and
 15 | folding are on or enabled by filetype.
 16 | 
 17 | ### Native Vim Package Manager
 18 | Vim has a native package manager loader for plugins (`:help packages`). Within
 19 | the `pack` directory create a folder structure ending with a `start` directory
 20 | and place the plugin inside its own directory, such as:
 21 | `~/.vim/pack/github/start/moosefw_vim`, then following the manual installation
 22 | method placing the contents in `moosefw_vim` OR clone the repository into the
 23 | directory
 24 | (`git clone https://github.com/elementx54/moosefw_vim.git moosefw_vim`).
 25 | 
 26 | The plugin should usually **not** be placed in an optionally loaded (`opt`)
 27 | directory due to the filetype detection being part of the plugin.
 28 | 
 29 | ### [vim-plug](https://github.com/junegunn/vim-plug) Method
 30 | Assuming you have already set up
 31 | [vim-plug](https://github.com/junegunn/vim-plug), place this plugin line in
 32 | the `.vimrc` to install:
 33 | ```vim
 34 | Plug 'elementx54/moosefw_vim'
 35 | ```
 36 | Then update your plugins with the command `:PlugInstall` when running `vim`.
 37 | The Vim style documentation should be updated as well.
 38 | _NOTE:_ Customization with Plug requires a specific order of operation. (See
 39 | [this closed issue](https://github.com/elementx54/moosefw_vim/issues/15).)
 40 | 
 41 | ### [Vundle](https://github.com/VundleVim/Vundle.vim) Method (Unmaintained)
 42 | <details>
 43 | <summary>Historic Instructions</summary>
 44 | 
 45 | Assuming you have already set up
 46 | [Vundle](https://github.com/VundleVim/Vundle.vim), place this plugin line in
 47 | the `.vimrc` to install:
 48 | ```vim
 49 | Plugin 'elementx54/moosefw_vim.git'
 50 | ```
 51 | Then update your plugins with the command `:PluginInstall` when running `vim`.
 52 | To include the plugin's Vim style documentation, use the command `:PluginDocs`.
 53 | </details>
 54 | 
 55 | ## CUSTOMIZATION
 56 | ---
 57 | Feel free to change highlighting colors in the `syntax/moose_fw.vim` file or
 58 | place a custom syntax file in the Vim `after` directory. Actually, feel free to
 59 | change anything.
 60 | I've also found it handy to syntax highlight the dump files (`--dump`) when
 61 | output into a file. You can either make the file extension match an input file
 62 | extension or tell Vim directly the filetype.
 63 | To tell Vim the filetype, place `# vi:filetype=moose_fw` at either the top or
 64 | bottom of the file.
 65 | 
 66 | ## INFORMATION
 67 | ---
 68 | ### MOOSE Input Format
 69 | MOOSE input format is loosely based off a
 70 | [GetPot](http://getpot.sourceforge.net/) input structure. The MOOSE input
 71 | parser now allows for more flexibility between parent and child pairs.
 72 | The syntax coloring is provided specifically for MOOSE keywords and
 73 | can be customized. Syntax highlighting works best with the old MOOSE input
 74 | structure. MOOSE input files traditionally end with `*.i`, but any
 75 | ending may be used as this plugin can search the input file's beginning
 76 | lines looking for a `[*Opening*]` and `[]` closing pair. This plugin identifies
 77 | MOOSE input files as being `filetype=moose_fw`. The `moose_fw` stands for
 78 | _MOOSE Framework_.
 79 | 
 80 | Although indentation formatting is not required, this plugin includes
 81 | indentation formatting based on user indentation settings. Auto-indentation
 82 | occurs as text is entered, both forward and backward indents. To fix indents on
 83 | an entire input file, use the Vim command in normal mode `gg=G`.
 84 | 
 85 | The style of folding is left up to each individual user. Folding by syntax or
 86 | indent can be set locally with an autocommand place in the `.vimrc` file.
 87 | ```vim
 88 | autocmd FileType moose_fw setlocal foldmethod=syntax|indent
 89 | ```
 90 | 
 91 | ### Default Configuration Values
 92 | For many of the configuration values to work properly, the location of the
 93 | command `filetype plugin on` in the `.vimrc` file MUST come after user defined
 94 | configuration values.
 95 | 
 96 | The number of lines to search the beginning of a file for a section pair of
 97 | bracket sets `[]` identifying the file as a `moose_fw` filetype.
 98 | ```vim
 99 | let g:moo_fw_search_lines = 50  " Defaults to 50 lines.
100 | ```
101 | 
102 | To disable searching files for bracket pairs identifying the file as a
103 | `moose_fw` filetype, create the global variable.
104 | ```vim
105 | let g:moo_fw_search_file_disable = 1  " Defaults to being enabled.
106 | ```
107 | 
108 | The input file extensions which could identify `moose_fw` filetype may be set
109 | with the global variable. The '*.' part is automatically applied to the list.
110 | ```vim
111 | let g:moo_fw_extensions = ["i"]  " Defaults to ["i"] for '*.i' file names.
112 | ```
113 | To disable file extension assignment of `moose_fw` filetype, set the global
114 | variable to an empty string.
115 | ```vim
116 | let g:moo_fw_extensions = []  " Automatic detection still searches unless disabled.
117 | ```
118 | 
119 | To disable the insertion of closing pairs when an opening pair has been typed,
120 | create the global variable.
121 | ```vim
122 | let g:moo_fw_no_insert_pairs = 1  " Defaults to being enabled.
123 | ```
124 | 
125 | To disable the key maps for commenting, create the global variable.
126 | ```vim
127 | let g:moo_fw_no_commenting = 1  " Defaults to being enabled.
128 | ```
129 | 


--------------------------------------------------------------------------------
/doc/moose_fw.txt:
--------------------------------------------------------------------------------
  1 | *moose_fw.txt*     MOOSE Framework input file helper for Vim         *moose_fw*
  2 | 
  3 | ===============================================================================
  4 | CONTENTS                                                    *moose_fw-contents*
  5 | 
  6 |  Introduction                                           |moose_fw-introduction|
  7 |  Installation                                           |moose_fw-installation|
  8 |  Information                                             |moose_fw-information|
  9 |  Configuration                                         |moose_fw-configuration|
 10 |  License                                                     |moose_fw-license|
 11 | 
 12 | ===============================================================================
 13 | INTRODUCTION                                            *moose_fw-introduction*
 14 | 
 15 | This is a Vim plugin to facilitate the creation of MOOSE input files. The
 16 | plugin defines the filetype of a MOOSE input file as `moose_fw`, being a
 17 | unique filetype to this plugin.
 18 | 
 19 | A `moose_fw` with this plugin features...
 20 | 
 21 |   - automatic detection of `moose_fw` file with and without common extensions
 22 |   - indentation correction, if desired, and automation
 23 |   - syntax highlighting based off old MOOSE input structure
 24 |   - give user ability to fold based on syntax or indentation
 25 |   - `moose_fw` Vim |section| movement
 26 | 
 27 | As MOOSE input files loosely follow the GetPot structure, the `moose_fw`
 28 | plugin might work well with any GetPot input file.
 29 | 
 30 | ===============================================================================
 31 | INSTALLATION                                            *moose_fw-installation*
 32 | 
 33 | The file structure of the `moose_fw` plugin should indicate the placement of
 34 | each file in the user's home Vim directory. |vimfiles| |add-global-plugin|
 35 | |add-local-help|
 36 | 
 37 | If using the native Vim package manager, make sure the plugin is not
 38 | optionally loaded as the filetype detection will not work. |packages|
 39 | 
 40 | The recommended method of installation is to use a Vim plugin manager like
 41 | vim-plug https://github.com/junegunn/vim-plug .
 42 | 
 43 | No matter the method of installation, the plugin works best when |syntax|,
 44 | indentation, and |folding| are on or enabled by |filetype| depending on which
 45 | plugin features are desired. |moose_fw-fold|
 46 | 
 47 | ===============================================================================
 48 | INFORMATION                                              *moose_fw-information*
 49 | 
 50 | Most functionality of `moose_fw` plugin is automatic and being aware of it is
 51 | probably sufficient for most users.
 52 | -------------------------------------------------------------------------------
 53 | *moose_fw-filetype*
 54 | 
 55 | The plugin activates when the filetype equals 'moose_fw' in Vim. The
 56 | traditional extension for MOOSE input files is '*.i' even though input file
 57 | are structured text files.
 58 | NOTE that this plugin invasively sets the filetype of '*.i' files to
 59 | 'moose_fw' by default.
 60 | 
 61 | The extensions for MOOSE input files are stored in a list |g:moo_fw_extensions|
 62 | allowing the user to specify file extensions. The plugin automatically adds
 63 | '*.' to the beginning of each item in the list. Example: ["mi"] becomes "*.mi"
 64 | when passed as the {pat} to the |autocmd|. Multiple extensions may be added to
 65 | the list, ["i", "mi"].
 66 | 
 67 | The plugin also detects MOOSE input file by searching the beginning of files
 68 | for a pair of opening ([Label]) and closing ([]) lines or for a test file
 69 | opener "[Tests]".
 70 | |g:moo_fw_search_file_disable| |g:moo_fw_search_lines|
 71 | 
 72 | The use of a |modeline| is recommended as this will correctly identify the
 73 | file by the user's specification.
 74 | -------------------------------------------------------------------------------
 75 | *moose_fw-indent*
 76 | 
 77 | Indentation formating is neither a requirement of the GetPot structure or
 78 | MOOSE input format. However, many still apply indentation for
 79 | human-readability. The plugin will automatically change indent levels based on
 80 | the current text being typed. Opening lines will increase the indent level of
 81 | the next line. Closing lines will decrease the indent level of the current
 82 | line. The change will only happen during typing after the closing bracket ']'
 83 | has been typed. For long strings (such as mesh subdomains), the indentation
 84 | will line up to the column directly after the first quote starting the string.
 85 | The indentation level will return to normal after the closing quote is placed.
 86 | NOTE that the Vim command 'gg=G' will fix indentation to the entire file.
 87 | -------------------------------------------------------------------------------
 88 | *moose_fw-syntax*
 89 | 
 90 | Syntax highlight is based entirely on MOOSE input keywords and MOOSE dump
 91 | file format. The highlighting works best on old style MOOSE input files.
 92 | 
 93 | Syntax highlighting will not and does not replace the knowledge of creating a
 94 | correct MOOSE input file. Do not rely on color to indicate a correct or false
 95 | input for MOOSE. You have been warned.
 96 | -------------------------------------------------------------------------------
 97 | *moose_fw-fold*
 98 | 
 99 | Folding method is left completely up to the user. Nothing is worse than having
100 | a plugin hide an entire file behind folds for a user who does not use or
101 | dislikes folds. Well, maybe something is worse than that, but it is still bad.
102 | The plugin creates a uniform indent and syntax strategy conducive to folding
103 | by either "indent" or "syntax". |foldmethod|
104 | -------------------------------------------------------------------------------
105 | *moose_fw-section*
106 | 
107 | For |section| movement in Vim, the plugin provides the correct command for the
108 | behavior expected in a GetPot structured input file. The cursor will navigate
109 | to opening or closing lines in the direction given.
110 | NOTE that the two key presses must not have a long-ish delay between them or
111 | the cursor will move to the beginning or end of the file based on direction.
112 | -------------------------------------------------------------------------------
113 | *moose_fw-insert_pairs*
114 | 
115 | A simple approach to inserting closing block pairs when the opener is typed is
116 | triggered on the press of the ']' key in |insert| mode. It does not execute
117 | when a comment is being typed or the preceding text does not match an opening
118 | block format. This does NOT check if a closer already exists.
119 | -------------------------------------------------------------------------------
120 | *moose_fw-commenting*
121 | 
122 | MOOSE inputs allow for comments. A common practice when debugging an input
123 | file is to "comment out" part of the input file and rerun the input file. To
124 | aid with this work flow, typing [count]<Leader>c|C converts the lines to
125 | comments and typing [count]<Leader>x|X removes the comment conversion. Lower
126 | case moves down the buffer, while upper case moves up the buffer. An effort is
127 | made to preserve indentation and previous|after comment indentation when in
128 | normal mode. Visual mode may or may not preserve comment indentation, but
129 | remains in visual mode after commenting is complete.
130 | 
131 | ===============================================================================
132 | CONFIGURATION                                          *moose_fw-configuration*
133 | 
134 | Customization is allowed and encouraged. Since MOOSE is a framework from which
135 | other animals (apps) are built, specific behavior for inputs into these
136 | animals may be placed in the |after-directory|. A common use is for syntax
137 | keywords specific to the animal.
138 | 
139 | NOTE that configuration variables MUST be defined before the |ftplugins| are
140 | turned on, which usually occurs in the user's |vimrc| file. If this
141 | requirement is a problem, please open an issue on the Git repository.
142 | -------------------------------------------------------------------------------
143 | *g:moo_fw_search_lines*
144 | 
145 | Controls number of lines to search when determining the filetype. >
146 |     let g:moo_fw_search_lines = 50
147 | <   Defaults to 50 lines. |moose_fw-filetype|
148 | -------------------------------------------------------------------------------
149 | *g:moo_fw_search_file_disable*
150 | 
151 | To disable searching of files to determine filetype, create the global
152 | variable: >
153 |     let g:moo_fw_search_file_disable = 1
154 | <   Defaults to being enabled (the variable does not exist).
155 |     |moose_fw-filetype|
156 | -------------------------------------------------------------------------------
157 | *g:moo_fw_extensions*
158 | 
159 | File extensions which signify a MOOSE input file should be stored as a list in
160 | the global variable: >
161 |     let g:moo_fw_extensions = ["i"]
162 | <   Defaults to ["i"] signifying '*.i' files. |moose_fw-filetype|
163 | The setting of filetype by extension may be disabled by setting the global
164 | variable to an empty list: >
165 |     let g:moo_fw_extensions = []
166 | <   To completely disable filetype detection, |g:moo_fw_search_file_disable|
167 |     and this must both be set correctly. |moose_fw-filetype|
168 | -------------------------------------------------------------------------------
169 | *g:moo_fw_no_insert_pairs*
170 | 
171 | To disable inserting closing block pairs when ']' is pressed, create the
172 | global variable: >
173 |     let g:moo_fw_no_insert_pairs = 1
174 | <   Defaults to being enabled (the variable does not exist).
175 |     |moose_fw-insert_pairs|
176 | -------------------------------------------------------------------------------
177 | *g:moo_fw_no_commenting*
178 | 
179 | To disable commenting key maps, create the global variable: >
180 |     let g:moo_fw_no_commenting = 1
181 | <   Defaults to being enabled (the variable does not exist).
182 |     |moose_fw-commenting|
183 | 
184 | ===============================================================================
185 | LICENSE                                                      *moose_fw-license*
186 | 
187 | This software is licensed under the GNU Lesser General Public License version
188 | 2.1, Copyright (C) 1991, 1999.
189 | Contributors to elementx54/moosefw_vim
190 | 
191 | vim: ft=help
192 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                   GNU LESSER GENERAL PUBLIC LICENSE
  2 |                        Version 2.1, February 1999
  3 | 
  4 |  Copyright (C) 1991, 1999 Free Software Foundation, Inc.
  5 |  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 | [This is the first released version of the Lesser GPL.  It also counts
 10 |  as the successor of the GNU Library Public License, version 2, hence
 11 |  the version number 2.1.]
 12 | 
 13 |                             Preamble
 14 | 
 15 |   The licenses for most software are designed to take away your
 16 | freedom to share and change it.  By contrast, the GNU General Public
 17 | Licenses are intended to guarantee your freedom to share and change
 18 | free software--to make sure the software is free for all its users.
 19 | 
 20 |   This license, the Lesser General Public License, applies to some
 21 | specially designated software packages--typically libraries--of the
 22 | Free Software Foundation and other authors who decide to use it.  You
 23 | can use it too, but we suggest you first think carefully about whether
 24 | this license or the ordinary General Public License is the better
 25 | strategy to use in any particular case, based on the explanations below.
 26 | 
 27 |   When we speak of free software, we are referring to freedom of use,
 28 | not price.  Our General Public Licenses are designed to make sure that
 29 | you have the freedom to distribute copies of free software (and charge
 30 | for this service if you wish); that you receive source code or can get
 31 | it if you want it; that you can change the software and use pieces of
 32 | it in new free programs; and that you are informed that you can do
 33 | these things.
 34 | 
 35 |   To protect your rights, we need to make restrictions that forbid
 36 | distributors to deny you these rights or to ask you to surrender these
 37 | rights.  These restrictions translate to certain responsibilities for
 38 | you if you distribute copies of the library or if you modify it.
 39 | 
 40 |   For example, if you distribute copies of the library, whether gratis
 41 | or for a fee, you must give the recipients all the rights that we gave
 42 | you.  You must make sure that they, too, receive or can get the source
 43 | code.  If you link other code with the library, you must provide
 44 | complete object files to the recipients, so that they can relink them
 45 | with the library after making changes to the library and recompiling
 46 | it.  And you must show them these terms so they know their rights.
 47 | 
 48 |   We protect your rights with a two-step method: (1) we copyright the
 49 | library, and (2) we offer you this license, which gives you legal
 50 | permission to copy, distribute and/or modify the library.
 51 | 
 52 |   To protect each distributor, we want to make it very clear that
 53 | there is no warranty for the free library.  Also, if the library is
 54 | modified by someone else and passed on, the recipients should know
 55 | that what they have is not the original version, so that the original
 56 | author's reputation will not be affected by problems that might be
 57 | introduced by others.
 58 | 
 59 |   Finally, software patents pose a constant threat to the existence of
 60 | any free program.  We wish to make sure that a company cannot
 61 | effectively restrict the users of a free program by obtaining a
 62 | restrictive license from a patent holder.  Therefore, we insist that
 63 | any patent license obtained for a version of the library must be
 64 | consistent with the full freedom of use specified in this license.
 65 | 
 66 |   Most GNU software, including some libraries, is covered by the
 67 | ordinary GNU General Public License.  This license, the GNU Lesser
 68 | General Public License, applies to certain designated libraries, and
 69 | is quite different from the ordinary General Public License.  We use
 70 | this license for certain libraries in order to permit linking those
 71 | libraries into non-free programs.
 72 | 
 73 |   When a program is linked with a library, whether statically or using
 74 | a shared library, the combination of the two is legally speaking a
 75 | combined work, a derivative of the original library.  The ordinary
 76 | General Public License therefore permits such linking only if the
 77 | entire combination fits its criteria of freedom.  The Lesser General
 78 | Public License permits more lax criteria for linking other code with
 79 | the library.
 80 | 
 81 |   We call this license the "Lesser" General Public License because it
 82 | does Less to protect the user's freedom than the ordinary General
 83 | Public License.  It also provides other free software developers Less
 84 | of an advantage over competing non-free programs.  These disadvantages
 85 | are the reason we use the ordinary General Public License for many
 86 | libraries.  However, the Lesser license provides advantages in certain
 87 | special circumstances.
 88 | 
 89 |   For example, on rare occasions, there may be a special need to
 90 | encourage the widest possible use of a certain library, so that it becomes
 91 | a de-facto standard.  To achieve this, non-free programs must be
 92 | allowed to use the library.  A more frequent case is that a free
 93 | library does the same job as widely used non-free libraries.  In this
 94 | case, there is little to gain by limiting the free library to free
 95 | software only, so we use the Lesser General Public License.
 96 | 
 97 |   In other cases, permission to use a particular library in non-free
 98 | programs enables a greater number of people to use a large body of
 99 | free software.  For example, permission to use the GNU C Library in
100 | non-free programs enables many more people to use the whole GNU
101 | operating system, as well as its variant, the GNU/Linux operating
102 | system.
103 | 
104 |   Although the Lesser General Public License is Less protective of the
105 | users' freedom, it does ensure that the user of a program that is
106 | linked with the Library has the freedom and the wherewithal to run
107 | that program using a modified version of the Library.
108 | 
109 |   The precise terms and conditions for copying, distribution and
110 | modification follow.  Pay close attention to the difference between a
111 | "work based on the library" and a "work that uses the library".  The
112 | former contains code derived from the library, whereas the latter must
113 | be combined with the library in order to run.
114 | 
115 |                   GNU LESSER GENERAL PUBLIC LICENSE
116 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
117 | 
118 |   0. This License Agreement applies to any software library or other
119 | program which contains a notice placed by the copyright holder or
120 | other authorized party saying it may be distributed under the terms of
121 | this Lesser General Public License (also called "this License").
122 | Each licensee is addressed as "you".
123 | 
124 |   A "library" means a collection of software functions and/or data
125 | prepared so as to be conveniently linked with application programs
126 | (which use some of those functions and data) to form executables.
127 | 
128 |   The "Library", below, refers to any such software library or work
129 | which has been distributed under these terms.  A "work based on the
130 | Library" means either the Library or any derivative work under
131 | copyright law: that is to say, a work containing the Library or a
132 | portion of it, either verbatim or with modifications and/or translated
133 | straightforwardly into another language.  (Hereinafter, translation is
134 | included without limitation in the term "modification".)
135 | 
136 |   "Source code" for a work means the preferred form of the work for
137 | making modifications to it.  For a library, complete source code means
138 | all the source code for all modules it contains, plus any associated
139 | interface definition files, plus the scripts used to control compilation
140 | and installation of the library.
141 | 
142 |   Activities other than copying, distribution and modification are not
143 | covered by this License; they are outside its scope.  The act of
144 | running a program using the Library is not restricted, and output from
145 | such a program is covered only if its contents constitute a work based
146 | on the Library (independent of the use of the Library in a tool for
147 | writing it).  Whether that is true depends on what the Library does
148 | and what the program that uses the Library does.
149 | 
150 |   1. You may copy and distribute verbatim copies of the Library's
151 | complete source code as you receive it, in any medium, provided that
152 | you conspicuously and appropriately publish on each copy an
153 | appropriate copyright notice and disclaimer of warranty; keep intact
154 | all the notices that refer to this License and to the absence of any
155 | warranty; and distribute a copy of this License along with the
156 | Library.
157 | 
158 |   You may charge a fee for the physical act of transferring a copy,
159 | and you may at your option offer warranty protection in exchange for a
160 | fee.
161 | 
162 |   2. You may modify your copy or copies of the Library or any portion
163 | of it, thus forming a work based on the Library, and copy and
164 | distribute such modifications or work under the terms of Section 1
165 | above, provided that you also meet all of these conditions:
166 | 
167 |     a) The modified work must itself be a software library.
168 | 
169 |     b) You must cause the files modified to carry prominent notices
170 |     stating that you changed the files and the date of any change.
171 | 
172 |     c) You must cause the whole of the work to be licensed at no
173 |     charge to all third parties under the terms of this License.
174 | 
175 |     d) If a facility in the modified Library refers to a function or a
176 |     table of data to be supplied by an application program that uses
177 |     the facility, other than as an argument passed when the facility
178 |     is invoked, then you must make a good faith effort to ensure that,
179 |     in the event an application does not supply such function or
180 |     table, the facility still operates, and performs whatever part of
181 |     its purpose remains meaningful.
182 | 
183 |     (For example, a function in a library to compute square roots has
184 |     a purpose that is entirely well-defined independent of the
185 |     application.  Therefore, Subsection 2d requires that any
186 |     application-supplied function or table used by this function must
187 |     be optional: if the application does not supply it, the square
188 |     root function must still compute square roots.)
189 | 
190 | These requirements apply to the modified work as a whole.  If
191 | identifiable sections of that work are not derived from the Library,
192 | and can be reasonably considered independent and separate works in
193 | themselves, then this License, and its terms, do not apply to those
194 | sections when you distribute them as separate works.  But when you
195 | distribute the same sections as part of a whole which is a work based
196 | on the Library, the distribution of the whole must be on the terms of
197 | this License, whose permissions for other licensees extend to the
198 | entire whole, and thus to each and every part regardless of who wrote
199 | it.
200 | 
201 | Thus, it is not the intent of this section to claim rights or contest
202 | your rights to work written entirely by you; rather, the intent is to
203 | exercise the right to control the distribution of derivative or
204 | collective works based on the Library.
205 | 
206 | In addition, mere aggregation of another work not based on the Library
207 | with the Library (or with a work based on the Library) on a volume of
208 | a storage or distribution medium does not bring the other work under
209 | the scope of this License.
210 | 
211 |   3. You may opt to apply the terms of the ordinary GNU General Public
212 | License instead of this License to a given copy of the Library.  To do
213 | this, you must alter all the notices that refer to this License, so
214 | that they refer to the ordinary GNU General Public License, version 2,
215 | instead of to this License.  (If a newer version than version 2 of the
216 | ordinary GNU General Public License has appeared, then you can specify
217 | that version instead if you wish.)  Do not make any other change in
218 | these notices.
219 | 
220 |   Once this change is made in a given copy, it is irreversible for
221 | that copy, so the ordinary GNU General Public License applies to all
222 | subsequent copies and derivative works made from that copy.
223 | 
224 |   This option is useful when you wish to copy part of the code of
225 | the Library into a program that is not a library.
226 | 
227 |   4. You may copy and distribute the Library (or a portion or
228 | derivative of it, under Section 2) in object code or executable form
229 | under the terms of Sections 1 and 2 above provided that you accompany
230 | it with the complete corresponding machine-readable source code, which
231 | must be distributed under the terms of Sections 1 and 2 above on a
232 | medium customarily used for software interchange.
233 | 
234 |   If distribution of object code is made by offering access to copy
235 | from a designated place, then offering equivalent access to copy the
236 | source code from the same place satisfies the requirement to
237 | distribute the source code, even though third parties are not
238 | compelled to copy the source along with the object code.
239 | 
240 |   5. A program that contains no derivative of any portion of the
241 | Library, but is designed to work with the Library by being compiled or
242 | linked with it, is called a "work that uses the Library".  Such a
243 | work, in isolation, is not a derivative work of the Library, and
244 | therefore falls outside the scope of this License.
245 | 
246 |   However, linking a "work that uses the Library" with the Library
247 | creates an executable that is a derivative of the Library (because it
248 | contains portions of the Library), rather than a "work that uses the
249 | library".  The executable is therefore covered by this License.
250 | Section 6 states terms for distribution of such executables.
251 | 
252 |   When a "work that uses the Library" uses material from a header file
253 | that is part of the Library, the object code for the work may be a
254 | derivative work of the Library even though the source code is not.
255 | Whether this is true is especially significant if the work can be
256 | linked without the Library, or if the work is itself a library.  The
257 | threshold for this to be true is not precisely defined by law.
258 | 
259 |   If such an object file uses only numerical parameters, data
260 | structure layouts and accessors, and small macros and small inline
261 | functions (ten lines or less in length), then the use of the object
262 | file is unrestricted, regardless of whether it is legally a derivative
263 | work.  (Executables containing this object code plus portions of the
264 | Library will still fall under Section 6.)
265 | 
266 |   Otherwise, if the work is a derivative of the Library, you may
267 | distribute the object code for the work under the terms of Section 6.
268 | Any executables containing that work also fall under Section 6,
269 | whether or not they are linked directly with the Library itself.
270 | 
271 |   6. As an exception to the Sections above, you may also combine or
272 | link a "work that uses the Library" with the Library to produce a
273 | work containing portions of the Library, and distribute that work
274 | under terms of your choice, provided that the terms permit
275 | modification of the work for the customer's own use and reverse
276 | engineering for debugging such modifications.
277 | 
278 |   You must give prominent notice with each copy of the work that the
279 | Library is used in it and that the Library and its use are covered by
280 | this License.  You must supply a copy of this License.  If the work
281 | during execution displays copyright notices, you must include the
282 | copyright notice for the Library among them, as well as a reference
283 | directing the user to the copy of this License.  Also, you must do one
284 | of these things:
285 | 
286 |     a) Accompany the work with the complete corresponding
287 |     machine-readable source code for the Library including whatever
288 |     changes were used in the work (which must be distributed under
289 |     Sections 1 and 2 above); and, if the work is an executable linked
290 |     with the Library, with the complete machine-readable "work that
291 |     uses the Library", as object code and/or source code, so that the
292 |     user can modify the Library and then relink to produce a modified
293 |     executable containing the modified Library.  (It is understood
294 |     that the user who changes the contents of definitions files in the
295 |     Library will not necessarily be able to recompile the application
296 |     to use the modified definitions.)
297 | 
298 |     b) Use a suitable shared library mechanism for linking with the
299 |     Library.  A suitable mechanism is one that (1) uses at run time a
300 |     copy of the library already present on the user's computer system,
301 |     rather than copying library functions into the executable, and (2)
302 |     will operate properly with a modified version of the library, if
303 |     the user installs one, as long as the modified version is
304 |     interface-compatible with the version that the work was made with.
305 | 
306 |     c) Accompany the work with a written offer, valid for at
307 |     least three years, to give the same user the materials
308 |     specified in Subsection 6a, above, for a charge no more
309 |     than the cost of performing this distribution.
310 | 
311 |     d) If distribution of the work is made by offering access to copy
312 |     from a designated place, offer equivalent access to copy the above
313 |     specified materials from the same place.
314 | 
315 |     e) Verify that the user has already received a copy of these
316 |     materials or that you have already sent this user a copy.
317 | 
318 |   For an executable, the required form of the "work that uses the
319 | Library" must include any data and utility programs needed for
320 | reproducing the executable from it.  However, as a special exception,
321 | the materials to be distributed need not include anything that is
322 | normally distributed (in either source or binary form) with the major
323 | components (compiler, kernel, and so on) of the operating system on
324 | which the executable runs, unless that component itself accompanies
325 | the executable.
326 | 
327 |   It may happen that this requirement contradicts the license
328 | restrictions of other proprietary libraries that do not normally
329 | accompany the operating system.  Such a contradiction means you cannot
330 | use both them and the Library together in an executable that you
331 | distribute.
332 | 
333 |   7. You may place library facilities that are a work based on the
334 | Library side-by-side in a single library together with other library
335 | facilities not covered by this License, and distribute such a combined
336 | library, provided that the separate distribution of the work based on
337 | the Library and of the other library facilities is otherwise
338 | permitted, and provided that you do these two things:
339 | 
340 |     a) Accompany the combined library with a copy of the same work
341 |     based on the Library, uncombined with any other library
342 |     facilities.  This must be distributed under the terms of the
343 |     Sections above.
344 | 
345 |     b) Give prominent notice with the combined library of the fact
346 |     that part of it is a work based on the Library, and explaining
347 |     where to find the accompanying uncombined form of the same work.
348 | 
349 |   8. You may not copy, modify, sublicense, link with, or distribute
350 | the Library except as expressly provided under this License.  Any
351 | attempt otherwise to copy, modify, sublicense, link with, or
352 | distribute the Library is void, and will automatically terminate your
353 | rights under this License.  However, parties who have received copies,
354 | or rights, from you under this License will not have their licenses
355 | terminated so long as such parties remain in full compliance.
356 | 
357 |   9. You are not required to accept this License, since you have not
358 | signed it.  However, nothing else grants you permission to modify or
359 | distribute the Library or its derivative works.  These actions are
360 | prohibited by law if you do not accept this License.  Therefore, by
361 | modifying or distributing the Library (or any work based on the
362 | Library), you indicate your acceptance of this License to do so, and
363 | all its terms and conditions for copying, distributing or modifying
364 | the Library or works based on it.
365 | 
366 |   10. Each time you redistribute the Library (or any work based on the
367 | Library), the recipient automatically receives a license from the
368 | original licensor to copy, distribute, link with or modify the Library
369 | subject to these terms and conditions.  You may not impose any further
370 | restrictions on the recipients' exercise of the rights granted herein.
371 | You are not responsible for enforcing compliance by third parties with
372 | this License.
373 | 
374 |   11. If, as a consequence of a court judgment or allegation of patent
375 | infringement or for any other reason (not limited to patent issues),
376 | conditions are imposed on you (whether by court order, agreement or
377 | otherwise) that contradict the conditions of this License, they do not
378 | excuse you from the conditions of this License.  If you cannot
379 | distribute so as to satisfy simultaneously your obligations under this
380 | License and any other pertinent obligations, then as a consequence you
381 | may not distribute the Library at all.  For example, if a patent
382 | license would not permit royalty-free redistribution of the Library by
383 | all those who receive copies directly or indirectly through you, then
384 | the only way you could satisfy both it and this License would be to
385 | refrain entirely from distribution of the Library.
386 | 
387 | If any portion of this section is held invalid or unenforceable under any
388 | particular circumstance, the balance of the section is intended to apply,
389 | and the section as a whole is intended to apply in other circumstances.
390 | 
391 | It is not the purpose of this section to induce you to infringe any
392 | patents or other property right claims or to contest validity of any
393 | such claims; this section has the sole purpose of protecting the
394 | integrity of the free software distribution system which is
395 | implemented by public license practices.  Many people have made
396 | generous contributions to the wide range of software distributed
397 | through that system in reliance on consistent application of that
398 | system; it is up to the author/donor to decide if he or she is willing
399 | to distribute software through any other system and a licensee cannot
400 | impose that choice.
401 | 
402 | This section is intended to make thoroughly clear what is believed to
403 | be a consequence of the rest of this License.
404 | 
405 |   12. If the distribution and/or use of the Library is restricted in
406 | certain countries either by patents or by copyrighted interfaces, the
407 | original copyright holder who places the Library under this License may add
408 | an explicit geographical distribution limitation excluding those countries,
409 | so that distribution is permitted only in or among countries not thus
410 | excluded.  In such case, this License incorporates the limitation as if
411 | written in the body of this License.
412 | 
413 |   13. The Free Software Foundation may publish revised and/or new
414 | versions of the Lesser General Public License from time to time.
415 | Such new versions will be similar in spirit to the present version,
416 | but may differ in detail to address new problems or concerns.
417 | 
418 | Each version is given a distinguishing version number.  If the Library
419 | specifies a version number of this License which applies to it and
420 | "any later version", you have the option of following the terms and
421 | conditions either of that version or of any later version published by
422 | the Free Software Foundation.  If the Library does not specify a
423 | license version number, you may choose any version ever published by
424 | the Free Software Foundation.
425 | 
426 |   14. If you wish to incorporate parts of the Library into other free
427 | programs whose distribution conditions are incompatible with these,
428 | write to the author to ask for permission.  For software which is
429 | copyrighted by the Free Software Foundation, write to the Free
430 | Software Foundation; we sometimes make exceptions for this.  Our
431 | decision will be guided by the two goals of preserving the free status
432 | of all derivatives of our free software and of promoting the sharing
433 | and reuse of software generally.
434 | 
435 |                             NO WARRANTY
436 | 
437 |   15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
443 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
444 | LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
446 | 
447 |   16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
456 | DAMAGES.
457 | 
458 |                      END OF TERMS AND CONDITIONS
459 | 
460 |            How to Apply These Terms to Your New Libraries
461 | 
462 |   If you develop a new library, and you want it to be of the greatest
463 | possible use to the public, we recommend making it free software that
464 | everyone can redistribute and change.  You can do so by permitting
465 | redistribution under these terms (or, alternatively, under the terms of the
466 | ordinary General Public License).
467 | 
468 |   To apply these terms, attach the following notices to the library.  It is
469 | safest to attach them to the start of each source file to most effectively
470 | convey the exclusion of warranty; and each file should have at least the
471 | "copyright" line and a pointer to where the full notice is found.
472 | 
473 |     <one line to give the library's name and a brief idea of what it does.>
474 |     Copyright (C) <year>  <name of author>
475 | 
476 |     This library is free software; you can redistribute it and/or
477 |     modify it under the terms of the GNU Lesser General Public
478 |     License as published by the Free Software Foundation; either
479 |     version 2.1 of the License, or (at your option) any later version.
480 | 
481 |     This library is distributed in the hope that it will be useful,
482 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
483 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
484 |     Lesser General Public License for more details.
485 | 
486 |     You should have received a copy of the GNU Lesser General Public
487 |     License along with this library; if not, write to the Free Software
488 |     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
489 | 
490 | Also add information on how to contact you by electronic and paper mail.
491 | 
492 | You should also get your employer (if you work as a programmer) or your
493 | school, if any, to sign a "copyright disclaimer" for the library, if
494 | necessary.  Here is a sample; alter the names:
495 | 
496 |   Yoyodyne, Inc., hereby disclaims all copyright interest in the
497 |   library `Frob' (a library for tweaking knobs) written by James Random Hacker.
498 | 
499 |   <signature of Ty Coon>, 1 April 1990
500 |   Ty Coon, President of Vice
501 | 
502 | That's all there is to it!
503 | 


--------------------------------------------------------------------------------