webpbn

README

webpbn

Jan Wolter's webpbn 3.0 XML format realization with go. Validation included.

License

MIT License

Copyright (c) 2021 Alexey Popov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Overview

Package webpbn – parser for Jan Wolter's "point by numbers" XML-based puzzle format.

Index

• func Parse(r io.Reader, options ...Option) (*ast.PuzzleSet, error)
• func ParseFile(name string, options ...Option) (*ast.PuzzleSet, error)
• type Option
  • func WithValidator(v Validator) Option
• type Options
• type Validator

Functions

func Parse

func Parse(r io.Reader, options ...Option) (*ast.PuzzleSet, error)

Parse puzzle set from reader.

func ParseFile

func ParseFile(name string, options ...Option) (*ast.PuzzleSet, error)

ParseFile loads puzzle set from file by name.

Types

type Option

type Option func(*Options)

Option puzzle parser option.

func WithValidator

func WithValidator(v Validator) Option

WithValidator option defines a puzzle validator.

type Options

type Options struct {
	Validator Validator
}

Options puzzle parser options.

type Validator

type Validator interface {
	Validate(puzzleSet *ast.PuzzleSet) error
}

Validator puzzle validator interface.