Merge pull request #8119 from hashicorp/switch_sed_because_license
templating: deprecate `sed` with `replace` and `replace_all`
This commit is contained in:
Megan Marsh
GitHub
commit
ca51bff695
1
go.mod
1
go.mod
|
|
@ -119,7 +119,6 @@ require (
|
||||||
github.com/posener/complete v1.1.1
|
github.com/posener/complete v1.1.1
|
||||||
github.com/profitbricks/profitbricks-sdk-go v4.0.2+incompatible
|
github.com/profitbricks/profitbricks-sdk-go v4.0.2+incompatible
|
||||||
github.com/renstrom/fuzzysearch v0.0.0-20160331204855-2d205ac6ec17 // indirect
|
github.com/renstrom/fuzzysearch v0.0.0-20160331204855-2d205ac6ec17 // indirect
|
||||||
github.com/rwtodd/Go.Sed v0.0.0-20170507045331-d6d5d585814e
|
|
||||||
github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735 // indirect
|
github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735 // indirect
|
||||||
github.com/saintfish/chardet v0.0.0-20120816061221-3af4cd4741ca // indirect
|
github.com/saintfish/chardet v0.0.0-20120816061221-3af4cd4741ca // indirect
|
||||||
github.com/satori/go.uuid v1.2.0 // indirect
|
github.com/satori/go.uuid v1.2.0 // indirect
|
||||||
|
|
|
||||||
2
go.sum
2
go.sum
|
|
@ -349,8 +349,6 @@ github.com/profitbricks/profitbricks-sdk-go v4.0.2+incompatible/go.mod h1:T3/Wrz
|
||||||
github.com/renstrom/fuzzysearch v0.0.0-20160331204855-2d205ac6ec17 h1:4qPms2txLWMLXKzqlnYSulKRS4cS9aYgPtAEpUelQok=
|
github.com/renstrom/fuzzysearch v0.0.0-20160331204855-2d205ac6ec17 h1:4qPms2txLWMLXKzqlnYSulKRS4cS9aYgPtAEpUelQok=
|
||||||
github.com/renstrom/fuzzysearch v0.0.0-20160331204855-2d205ac6ec17/go.mod h1:SAEjPB4voP88qmWJXI7mA5m15uNlEnuHLx4Eu2mPGpQ=
|
github.com/renstrom/fuzzysearch v0.0.0-20160331204855-2d205ac6ec17/go.mod h1:SAEjPB4voP88qmWJXI7mA5m15uNlEnuHLx4Eu2mPGpQ=
|
||||||
github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
|
github.com/rogpeppe/fastuuid v0.0.0-20150106093220-6724a57986af/go.mod h1:XWv6SoW27p1b0cqNHllgS5HIMJraePCO15w5zCzIWYg=
|
||||||
github.com/rwtodd/Go.Sed v0.0.0-20170507045331-d6d5d585814e h1:lN+IKs+Jb9uwDOMO4VJZzH9vOjjist0THR5s9akp+Ss=
|
|
||||||
github.com/rwtodd/Go.Sed v0.0.0-20170507045331-d6d5d585814e/go.mod h1:8AEUvGVi2uQ5b24BIhcr0GCcpd/RNAFWaN2CJFrWIIQ=
|
|
||||||
github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
|
github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb6uqfes/u+d4ooFouqFdy9/2g9QGwK3SQygK0Ts=
|
||||||
github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735 h1:7YvPJVmEeFHR1Tj9sZEYsmarJEQfMVYpd/Vyy/A8dqE=
|
github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735 h1:7YvPJVmEeFHR1Tj9sZEYsmarJEQfMVYpd/Vyy/A8dqE=
|
||||||
github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735/go.mod h1:807d1WSdnB0XRJzKNil9Om6lcp/3a0v4qIHxIXzX/Yc=
|
github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735/go.mod h1:807d1WSdnB0XRJzKNil9Om6lcp/3a0v4qIHxIXzX/Yc=
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,6 @@ import (
|
||||||
"github.com/hashicorp/packer/common/uuid"
|
"github.com/hashicorp/packer/common/uuid"
|
||||||
"github.com/hashicorp/packer/version"
|
"github.com/hashicorp/packer/version"
|
||||||
vaultapi "github.com/hashicorp/vault/api"
|
vaultapi "github.com/hashicorp/vault/api"
|
||||||
"github.com/rwtodd/Go.Sed/sed"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// InitTime is the UTC time when this package was initialized. It is
|
// InitTime is the UTC time when this package was initialized. It is
|
||||||
|
|
@ -27,7 +26,7 @@ func init() {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Funcs are the interpolation funcs that are available within interpolations.
|
// Funcs are the interpolation funcs that are available within interpolations.
|
||||||
var FuncGens = map[string]FuncGenerator{
|
var FuncGens = map[string]interface{}{
|
||||||
"build_name": funcGenBuildName,
|
"build_name": funcGenBuildName,
|
||||||
"build_type": funcGenBuildType,
|
"build_type": funcGenBuildType,
|
||||||
"env": funcGenEnv,
|
"env": funcGenEnv,
|
||||||
|
|
@ -43,8 +42,11 @@ var FuncGens = map[string]FuncGenerator{
|
||||||
"vault": funcGenVault,
|
"vault": funcGenVault,
|
||||||
"sed": funcGenSed,
|
"sed": funcGenSed,
|
||||||
|
|
||||||
"upper": funcGenPrimitive(strings.ToUpper),
|
"replace": replace,
|
||||||
"lower": funcGenPrimitive(strings.ToLower),
|
"replace_all": replace_all,
|
||||||
|
|
||||||
|
"upper": strings.ToUpper,
|
||||||
|
"lower": strings.ToLower,
|
||||||
}
|
}
|
||||||
|
|
||||||
var ErrVariableNotSetString = "Error: variable not set:"
|
var ErrVariableNotSetString = "Error: variable not set:"
|
||||||
|
|
@ -58,7 +60,12 @@ type FuncGenerator func(*Context) interface{}
|
||||||
func Funcs(ctx *Context) template.FuncMap {
|
func Funcs(ctx *Context) template.FuncMap {
|
||||||
result := make(map[string]interface{})
|
result := make(map[string]interface{})
|
||||||
for k, v := range FuncGens {
|
for k, v := range FuncGens {
|
||||||
result[k] = v(ctx)
|
switch v := v.(type) {
|
||||||
|
case func(*Context) interface{}:
|
||||||
|
result[k] = v(ctx)
|
||||||
|
default:
|
||||||
|
result[k] = v
|
||||||
|
}
|
||||||
}
|
}
|
||||||
if ctx != nil {
|
if ctx != nil {
|
||||||
for k, v := range ctx.Funcs {
|
for k, v := range ctx.Funcs {
|
||||||
|
|
@ -126,12 +133,6 @@ func funcGenIsotime(ctx *Context) interface{} {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func funcGenPrimitive(value interface{}) FuncGenerator {
|
|
||||||
return func(ctx *Context) interface{} {
|
|
||||||
return value
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func funcGenPwd(ctx *Context) interface{} {
|
func funcGenPwd(ctx *Context) interface{} {
|
||||||
return func() (string, error) {
|
return func() (string, error) {
|
||||||
return os.Getwd()
|
return os.Getwd()
|
||||||
|
|
@ -268,22 +269,16 @@ func funcGenVault(ctx *Context) interface{} {
|
||||||
|
|
||||||
func funcGenSed(ctx *Context) interface{} {
|
func funcGenSed(ctx *Context) interface{} {
|
||||||
return func(expression string, inputString string) (string, error) {
|
return func(expression string, inputString string) (string, error) {
|
||||||
engine, err := sed.New(strings.NewReader(expression))
|
return "", errors.New("template function `sed` is deprecated " +
|
||||||
|
"use `replace` or `replace_all` instead." +
|
||||||
if err != nil {
|
"Documentation: https://www.packer.io/docs/templates/engine.html")
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := engine.RunString(inputString)
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
// The sed library adds a \n to all processed strings.
|
|
||||||
resultLength := len(result)
|
|
||||||
result = result[:resultLength-1]
|
|
||||||
|
|
||||||
return result, err
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func replace_all(old, new, src string) string {
|
||||||
|
return strings.ReplaceAll(src, old, new)
|
||||||
|
}
|
||||||
|
|
||||||
|
func replace(old, new string, n int, src string) string {
|
||||||
|
return strings.Replace(src, old, new, n)
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -8,6 +8,7 @@ import (
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"github.com/google/go-cmp/cmp"
|
||||||
"github.com/hashicorp/packer/version"
|
"github.com/hashicorp/packer/version"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
@ -316,30 +317,36 @@ func TestFuncPackerVersion(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestFuncSed(t *testing.T) {
|
func TestReplaceFuncs(t *testing.T) {
|
||||||
cases := []struct {
|
cases := []struct {
|
||||||
Input string
|
Input string
|
||||||
Output string
|
Output string
|
||||||
}{
|
}{
|
||||||
|
|
||||||
{
|
{
|
||||||
`{{sed "s|hello|world|" "hello"}}`,
|
`{{ "foo-bar-baz" | replace "-" "/" 1}}`,
|
||||||
`world`,
|
`foo/bar-baz`,
|
||||||
},
|
},
|
||||||
|
|
||||||
{
|
{
|
||||||
`{{sed "s|foo|bar|" "hello"}}`,
|
`{{ replace "-" "/" 1 "foo-bar-baz" }}`,
|
||||||
`hello`,
|
`foo/bar-baz`,
|
||||||
},
|
},
|
||||||
|
|
||||||
{
|
{
|
||||||
`{{user "foo" | sed "s|foo|bar|"}}`,
|
`{{ "I Am Henry VIII" | replace_all " " "-" }}`,
|
||||||
`bar`,
|
`I-Am-Henry-VIII`,
|
||||||
|
},
|
||||||
|
|
||||||
|
{
|
||||||
|
`{{ replace_all " " "-" "I Am Henry VIII" }}`,
|
||||||
|
`I-Am-Henry-VIII`,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx := &Context{
|
ctx := &Context{
|
||||||
UserVariables: map[string]string{
|
UserVariables: map[string]string{
|
||||||
"foo": "foo",
|
"fee": "-foo-",
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
for _, tc := range cases {
|
for _, tc := range cases {
|
||||||
|
|
@ -349,8 +356,8 @@ func TestFuncSed(t *testing.T) {
|
||||||
t.Fatalf("Input: %s\n\nerr: %s", tc.Input, err)
|
t.Fatalf("Input: %s\n\nerr: %s", tc.Input, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
if result != tc.Output {
|
if diff := cmp.Diff(tc.Output, result); diff != "" {
|
||||||
t.Fatalf("Input: %s\n\nGot: %s", tc.Input, result)
|
t.Fatalf("Unexpected output: %s", diff)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,674 +0,0 @@
|
||||||
GNU GENERAL PUBLIC LICENSE
|
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
the GNU General Public License is intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains free
|
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
|
||||||
GNU General Public License for most of our software; it applies also to
|
|
||||||
any other work released this way by its authors. You can apply it to
|
|
||||||
your programs, too.
|
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
|
||||||
have the freedom to distribute copies of free software (and charge for
|
|
||||||
them if you wish), that you receive source code or can get it if you
|
|
||||||
want it, that you can change the software or use pieces of it in new
|
|
||||||
free programs, and that you know you can do these things.
|
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
|
||||||
or can get the source code. And you must show them these terms so they
|
|
||||||
know their rights.
|
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
|
||||||
that there is no warranty for this free software. For both users' and
|
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
|
||||||
changed, so that their problems will not be attributed erroneously to
|
|
||||||
authors of previous versions.
|
|
||||||
|
|
||||||
Some devices are designed to deny users access to install or run
|
|
||||||
modified versions of the software inside them, although the manufacturer
|
|
||||||
can do so. This is fundamentally incompatible with the aim of
|
|
||||||
protecting users' freedom to change the software. The systematic
|
|
||||||
pattern of such abuse occurs in the area of products for individuals to
|
|
||||||
use, which is precisely where it is most unacceptable. Therefore, we
|
|
||||||
have designed this version of the GPL to prohibit the practice for those
|
|
||||||
products. If such problems arise substantially in other domains, we
|
|
||||||
stand ready to extend this provision to those domains in future versions
|
|
||||||
of the GPL, as needed to protect the freedom of users.
|
|
||||||
|
|
||||||
Finally, every program is threatened constantly by software patents.
|
|
||||||
States should not allow patents to restrict development and use of
|
|
||||||
software on general-purpose computers, but in those that do, we wish to
|
|
||||||
avoid the special danger that patents applied to a free program could
|
|
||||||
make it effectively proprietary. To prevent this, the GPL assures that
|
|
||||||
patents cannot be used to render the program non-free.
|
|
||||||
|
|
||||||
The precise terms and conditions for copying, distribution and
|
|
||||||
modification follow.
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
0. Definitions.
|
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
|
||||||
works, such as semiconductor masks.
|
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
|
||||||
"recipients" may be individuals or organizations.
|
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
|
||||||
earlier work or a work "based on" the earlier work.
|
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
|
||||||
on the Program.
|
|
||||||
|
|
||||||
To "propagate" a work means to do anything with it that, without
|
|
||||||
permission, would make you directly or secondarily liable for
|
|
||||||
infringement under applicable copyright law, except executing it on a
|
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
|
||||||
distribution (with or without modification), making available to the
|
|
||||||
public, and in some countries other activities as well.
|
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
|
||||||
to the extent that it includes a convenient and prominently visible
|
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
|
||||||
tells the user that there is no warranty for the work (except to the
|
|
||||||
extent that warranties are provided), that licensees may convey the
|
|
||||||
work under this License, and how to view a copy of this License. If
|
|
||||||
the interface presents a list of user commands or options, such as a
|
|
||||||
menu, a prominent item in the list meets this criterion.
|
|
||||||
|
|
||||||
1. Source Code.
|
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
|
||||||
for making modifications to it. "Object code" means any non-source
|
|
||||||
form of a work.
|
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
|
||||||
standard defined by a recognized standards body, or, in the case of
|
|
||||||
interfaces specified for a particular programming language, one that
|
|
||||||
is widely used among developers working in that language.
|
|
||||||
|
|
||||||
The "System Libraries" of an executable work include anything, other
|
|
||||||
than the work as a whole, that (a) is included in the normal form of
|
|
||||||
packaging a Major Component, but which is not part of that Major
|
|
||||||
Component, and (b) serves only to enable use of the work with that
|
|
||||||
Major Component, or to implement a Standard Interface for which an
|
|
||||||
implementation is available to the public in source code form. A
|
|
||||||
"Major Component", in this context, means a major essential component
|
|
||||||
(kernel, window system, and so on) of the specific operating system
|
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
|
||||||
produce the work, or an object code interpreter used to run it.
|
|
||||||
|
|
||||||
The "Corresponding Source" for a work in object code form means all
|
|
||||||
the source code needed to generate, install, and (for an executable
|
|
||||||
work) run the object code and to modify the work, including scripts to
|
|
||||||
control those activities. However, it does not include the work's
|
|
||||||
System Libraries, or general-purpose tools or generally available free
|
|
||||||
programs which are used unmodified in performing those activities but
|
|
||||||
which are not part of the work. For example, Corresponding Source
|
|
||||||
includes interface definition files associated with source files for
|
|
||||||
the work, and the source code for shared libraries and dynamically
|
|
||||||
linked subprograms that the work is specifically designed to require,
|
|
||||||
such as by intimate data communication or control flow between those
|
|
||||||
subprograms and other parts of the work.
|
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
|
||||||
can regenerate automatically from other parts of the Corresponding
|
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
|
||||||
same work.
|
|
||||||
|
|
||||||
2. Basic Permissions.
|
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
|
||||||
permission to run the unmodified Program. The output from running a
|
|
||||||
covered work is covered by this License only if the output, given its
|
|
||||||
content, constitutes a covered work. This License acknowledges your
|
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
|
||||||
convey, without conditions so long as your license otherwise remains
|
|
||||||
in force. You may convey covered works to others for the sole purpose
|
|
||||||
of having them make modifications exclusively for you, or provide you
|
|
||||||
with facilities for running those works, provided that you comply with
|
|
||||||
the terms of this License in conveying all material for which you do
|
|
||||||
not control copyright. Those thus making or running the covered works
|
|
||||||
for you must do so exclusively on your behalf, under your direction
|
|
||||||
and control, on terms that prohibit them from making any copies of
|
|
||||||
your copyrighted material outside their relationship with you.
|
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
|
||||||
makes it unnecessary.
|
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
|
||||||
measure under any applicable law fulfilling obligations under article
|
|
||||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
|
||||||
similar laws prohibiting or restricting circumvention of such
|
|
||||||
measures.
|
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
|
||||||
circumvention of technological measures to the extent such circumvention
|
|
||||||
is effected by exercising rights under this License with respect to
|
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
|
||||||
modification of the work as a means of enforcing, against the work's
|
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
|
||||||
technological measures.
|
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
|
||||||
receive it, in any medium, provided that you conspicuously and
|
|
||||||
appropriately publish on each copy an appropriate copyright notice;
|
|
||||||
keep intact all notices stating that this License and any
|
|
||||||
non-permissive terms added in accord with section 7 apply to the code;
|
|
||||||
keep intact all notices of the absence of any warranty; and give all
|
|
||||||
recipients a copy of this License along with the Program.
|
|
||||||
|
|
||||||
You may charge any price or no price for each copy that you convey,
|
|
||||||
and you may offer support or warranty protection for a fee.
|
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
|
||||||
produce it from the Program, in the form of source code under the
|
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
|
||||||
it, and giving a relevant date.
|
|
||||||
|
|
||||||
b) The work must carry prominent notices stating that it is
|
|
||||||
released under this License and any conditions added under section
|
|
||||||
7. This requirement modifies the requirement in section 4 to
|
|
||||||
"keep intact all notices".
|
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
|
||||||
License will therefore apply, along with any applicable section 7
|
|
||||||
additional terms, to the whole of the work, and all its parts,
|
|
||||||
regardless of how they are packaged. This License gives no
|
|
||||||
permission to license the work in any other way, but it does not
|
|
||||||
invalidate such permission if you have separately received it.
|
|
||||||
|
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
|
||||||
work need not make them do so.
|
|
||||||
|
|
||||||
A compilation of a covered work with other separate and independent
|
|
||||||
works, which are not by their nature extensions of the covered work,
|
|
||||||
and which are not combined with it such as to form a larger program,
|
|
||||||
in or on a volume of a storage or distribution medium, is called an
|
|
||||||
"aggregate" if the compilation and its resulting copyright are not
|
|
||||||
used to limit the access or legal rights of the compilation's users
|
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
|
||||||
in an aggregate does not cause this License to apply to the other
|
|
||||||
parts of the aggregate.
|
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
|
||||||
of sections 4 and 5, provided that you also convey the
|
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
|
||||||
in one of these ways:
|
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by the
|
|
||||||
Corresponding Source fixed on a durable physical medium
|
|
||||||
customarily used for software interchange.
|
|
||||||
|
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
|
||||||
written offer, valid for at least three years and valid for as
|
|
||||||
long as you offer spare parts or customer support for that product
|
|
||||||
model, to give anyone who possesses the object code either (1) a
|
|
||||||
copy of the Corresponding Source for all the software in the
|
|
||||||
product that is covered by this License, on a durable physical
|
|
||||||
medium customarily used for software interchange, for a price no
|
|
||||||
more than your reasonable cost of physically performing this
|
|
||||||
conveying of source, or (2) access to copy the
|
|
||||||
Corresponding Source from a network server at no charge.
|
|
||||||
|
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
|
||||||
only if you received the object code with such an offer, in accord
|
|
||||||
with subsection 6b.
|
|
||||||
|
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
|
||||||
Corresponding Source in the same way through the same place at no
|
|
||||||
further charge. You need not require recipients to copy the
|
|
||||||
Corresponding Source along with the object code. If the place to
|
|
||||||
copy the object code is a network server, the Corresponding Source
|
|
||||||
may be on a different server (operated by you or a third party)
|
|
||||||
that supports equivalent copying facilities, provided you maintain
|
|
||||||
clear directions next to the object code saying where to find the
|
|
||||||
Corresponding Source. Regardless of what server hosts the
|
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
|
||||||
available for as long as needed to satisfy these requirements.
|
|
||||||
|
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
|
||||||
you inform other peers where the object code and Corresponding
|
|
||||||
Source of the work are being offered to the general public at no
|
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
|
||||||
from the Corresponding Source as a System Library, need not be
|
|
||||||
included in conveying the object code work.
|
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
|
||||||
tangible personal property which is normally used for personal, family,
|
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
|
||||||
product received by a particular user, "normally used" refers to a
|
|
||||||
typical or common use of that class of product, regardless of the status
|
|
||||||
of the particular user or of the way in which the particular user
|
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
|
||||||
is a consumer product regardless of whether the product has substantial
|
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
|
||||||
the only significant mode of use of the product.
|
|
||||||
|
|
||||||
"Installation Information" for a User Product means any methods,
|
|
||||||
procedures, authorization keys, or other information required to install
|
|
||||||
and execute modified versions of a covered work in that User Product from
|
|
||||||
a modified version of its Corresponding Source. The information must
|
|
||||||
suffice to ensure that the continued functioning of the modified object
|
|
||||||
code is in no case prevented or interfered with solely because
|
|
||||||
modification has been made.
|
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
|
||||||
specifically for use in, a User Product, and the conveying occurs as
|
|
||||||
part of a transaction in which the right of possession and use of the
|
|
||||||
User Product is transferred to the recipient in perpetuity or for a
|
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
|
||||||
by the Installation Information. But this requirement does not apply
|
|
||||||
if neither you nor any third party retains the ability to install
|
|
||||||
modified object code on the User Product (for example, the work has
|
|
||||||
been installed in ROM).
|
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
|
||||||
requirement to continue to provide support service, warranty, or updates
|
|
||||||
for a work that has been modified or installed by the recipient, or for
|
|
||||||
the User Product in which it has been modified or installed. Access to a
|
|
||||||
network may be denied when the modification itself materially and
|
|
||||||
adversely affects the operation of the network or violates the rules and
|
|
||||||
protocols for communication across the network.
|
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
|
||||||
in accord with this section must be in a format that is publicly
|
|
||||||
documented (and with an implementation available to the public in
|
|
||||||
source code form), and must require no special password or key for
|
|
||||||
unpacking, reading or copying.
|
|
||||||
|
|
||||||
7. Additional Terms.
|
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
|
||||||
License by making exceptions from one or more of its conditions.
|
|
||||||
Additional permissions that are applicable to the entire Program shall
|
|
||||||
be treated as though they were included in this License, to the extent
|
|
||||||
that they are valid under applicable law. If additional permissions
|
|
||||||
apply only to part of the Program, that part may be used separately
|
|
||||||
under those permissions, but the entire Program remains governed by
|
|
||||||
this License without regard to the additional permissions.
|
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
|
||||||
remove any additional permissions from that copy, or from any part of
|
|
||||||
it. (Additional permissions may be written to require their own
|
|
||||||
removal in certain cases when you modify the work.) You may place
|
|
||||||
additional permissions on material, added by you to a covered work,
|
|
||||||
for which you have or can give appropriate copyright permission.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
|
||||||
that material) supplement the terms of this License with terms:
|
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
|
||||||
terms of sections 15 and 16 of this License; or
|
|
||||||
|
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
|
||||||
Notices displayed by works containing it; or
|
|
||||||
|
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
|
||||||
|
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
|
||||||
authors of the material; or
|
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
|
||||||
|
|
||||||
f) Requiring indemnification of licensors and authors of that
|
|
||||||
material by anyone who conveys the material (or modified versions of
|
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
|
||||||
any liability that these contractual assumptions directly impose on
|
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
|
||||||
received it, or any part of it, contains a notice stating that it is
|
|
||||||
governed by this License along with a term that is a further
|
|
||||||
restriction, you may remove that term. If a license document contains
|
|
||||||
a further restriction but permits relicensing or conveying under this
|
|
||||||
License, you may add to a covered work material governed by the terms
|
|
||||||
of that license document, provided that the further restriction does
|
|
||||||
not survive such relicensing or conveying.
|
|
||||||
|
|
||||||
If you add terms to a covered work in accord with this section, you
|
|
||||||
must place, in the relevant source files, a statement of the
|
|
||||||
additional terms that apply to those files, or a notice indicating
|
|
||||||
where to find the applicable terms.
|
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
|
||||||
form of a separately written license, or stated as exceptions;
|
|
||||||
the above requirements apply either way.
|
|
||||||
|
|
||||||
8. Termination.
|
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
|
||||||
modify it is void, and will automatically terminate your rights under
|
|
||||||
this License (including any patent licenses granted under the third
|
|
||||||
paragraph of section 11).
|
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
|
||||||
license from a particular copyright holder is reinstated (a)
|
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
|
||||||
holder fails to notify you of the violation by some reasonable means
|
|
||||||
prior to 60 days after the cessation.
|
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
|
||||||
violation by some reasonable means, this is the first time you have
|
|
||||||
received notice of violation of this License (for any work) from that
|
|
||||||
copyright holder, and you cure the violation prior to 30 days after
|
|
||||||
your receipt of the notice.
|
|
||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
|
||||||
licenses of parties who have received copies or rights from you under
|
|
||||||
this License. If your rights have been terminated and not permanently
|
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
|
||||||
material under section 10.
|
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
|
||||||
to receive a copy likewise does not require acceptance. However,
|
|
||||||
nothing other than this License grants you permission to propagate or
|
|
||||||
modify any covered work. These actions infringe copyright if you do
|
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
|
||||||
receives a license from the original licensors, to run, modify and
|
|
||||||
propagate that work, subject to this License. You are not responsible
|
|
||||||
for enforcing compliance by third parties with this License.
|
|
||||||
|
|
||||||
An "entity transaction" is a transaction transferring control of an
|
|
||||||
organization, or substantially all assets of one, or subdividing an
|
|
||||||
organization, or merging organizations. If propagation of a covered
|
|
||||||
work results from an entity transaction, each party to that
|
|
||||||
transaction who receives a copy of the work also receives whatever
|
|
||||||
licenses to the work the party's predecessor in interest had or could
|
|
||||||
give under the previous paragraph, plus a right to possession of the
|
|
||||||
Corresponding Source of the work from the predecessor in interest, if
|
|
||||||
the predecessor has it or can get it with reasonable efforts.
|
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
|
||||||
rights granted or affirmed under this License. For example, you may
|
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
|
||||||
rights granted under this License, and you may not initiate litigation
|
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
|
||||||
sale, or importing the Program or any portion of it.
|
|
||||||
|
|
||||||
11. Patents.
|
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
|
||||||
License of the Program or a work on which the Program is based. The
|
|
||||||
work thus licensed is called the contributor's "contributor version".
|
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
|
||||||
owned or controlled by the contributor, whether already acquired or
|
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
|
||||||
by this License, of making, using, or selling its contributor version,
|
|
||||||
but do not include claims that would be infringed only as a
|
|
||||||
consequence of further modification of the contributor version. For
|
|
||||||
purposes of this definition, "control" includes the right to grant
|
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
|
||||||
this License.
|
|
||||||
|
|
||||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
|
||||||
patent license under the contributor's essential patent claims, to
|
|
||||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
|
||||||
propagate the contents of its contributor version.
|
|
||||||
|
|
||||||
In the following three paragraphs, a "patent license" is any express
|
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
|
||||||
(such as an express permission to practice a patent or covenant not to
|
|
||||||
sue for patent infringement). To "grant" such a patent license to a
|
|
||||||
party means to make such an agreement or commitment not to enforce a
|
|
||||||
patent against the party.
|
|
||||||
|
|
||||||
If you convey a covered work, knowingly relying on a patent license,
|
|
||||||
and the Corresponding Source of the work is not available for anyone
|
|
||||||
to copy, free of charge and under the terms of this License, through a
|
|
||||||
publicly available network server or other readily accessible means,
|
|
||||||
then you must either (1) cause the Corresponding Source to be so
|
|
||||||
available, or (2) arrange to deprive yourself of the benefit of the
|
|
||||||
patent license for this particular work, or (3) arrange, in a manner
|
|
||||||
consistent with the requirements of this License, to extend the patent
|
|
||||||
license to downstream recipients. "Knowingly relying" means you have
|
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
|
||||||
covered work in a country, or your recipient's use of the covered work
|
|
||||||
in a country, would infringe one or more identifiable patents in that
|
|
||||||
country that you have reason to believe are valid.
|
|
||||||
|
|
||||||
If, pursuant to or in connection with a single transaction or
|
|
||||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
|
||||||
covered work, and grant a patent license to some of the parties
|
|
||||||
receiving the covered work authorizing them to use, propagate, modify
|
|
||||||
or convey a specific copy of the covered work, then the patent license
|
|
||||||
you grant is automatically extended to all recipients of the covered
|
|
||||||
work and works based on it.
|
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
|
||||||
specifically granted under this License. You may not convey a covered
|
|
||||||
work if you are a party to an arrangement with a third party that is
|
|
||||||
in the business of distributing software, under which you make payment
|
|
||||||
to the third party based on the extent of your activity of conveying
|
|
||||||
the work, and under which the third party grants, to any of the
|
|
||||||
parties who would receive the covered work from you, a discriminatory
|
|
||||||
patent license (a) in connection with copies of the covered work
|
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
|
||||||
for and in connection with specific products or compilations that
|
|
||||||
contain the covered work, unless you entered into that arrangement,
|
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
|
||||||
any implied license or other defenses to infringement that may
|
|
||||||
otherwise be available to you under applicable patent law.
|
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
|
||||||
the Program, the only way you could satisfy both those terms and this
|
|
||||||
License would be to refrain entirely from conveying the Program.
|
|
||||||
|
|
||||||
13. Use with the GNU Affero General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU Affero General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the special requirements of the GNU Affero General Public License,
|
|
||||||
section 13, concerning interaction through a network will apply to the
|
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
|
||||||
the GNU General Public License from time to time. Such new versions will
|
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
|
||||||
address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
|
||||||
Program specifies that a certain numbered version of the GNU General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU General Public License, you may choose any version ever published
|
|
||||||
by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
|
||||||
|
|
||||||
16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
|
||||||
SUCH DAMAGES.
|
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
{one line to give the program's name and a brief idea of what it does.}
|
|
||||||
Copyright (C) {year} {name of author}
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
{project} Copyright (C) {year} {fullname}
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<http://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
package sed
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"regexp"
|
|
||||||
)
|
|
||||||
|
|
||||||
// conditions are what I'm calling the '1,10' in
|
|
||||||
// commands ike '1,10 d'. They are the line numbers,
|
|
||||||
// regexps, and '$' that you can use to control when
|
|
||||||
// commands execute.
|
|
||||||
|
|
||||||
type condition interface {
|
|
||||||
isMet(svm *vm) bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// -----------------------------------------------------
|
|
||||||
type numbercond int // for matching line number conditions
|
|
||||||
|
|
||||||
func (n numbercond) isMet(svm *vm) bool {
|
|
||||||
return svm.lineno == int(n)
|
|
||||||
}
|
|
||||||
|
|
||||||
// -----------------------------------------------------
|
|
||||||
type eofcond struct{} // for matching the condition '$'
|
|
||||||
|
|
||||||
func (_ eofcond) isMet(svm *vm) bool {
|
|
||||||
return svm.lastl
|
|
||||||
}
|
|
||||||
|
|
||||||
// -----------------------------------------------------
|
|
||||||
type regexpcond struct {
|
|
||||||
re *regexp.Regexp // for matching regexp conditions
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *regexpcond) isMet(svm *vm) (answer bool) {
|
|
||||||
return r.re.MatchString(svm.pat)
|
|
||||||
}
|
|
||||||
|
|
||||||
func newRECondition(s string, loc *location) (*regexpcond, error) {
|
|
||||||
re, err := regexp.Compile(s)
|
|
||||||
if err != nil {
|
|
||||||
err = fmt.Errorf("Regexp Error: %s %v", err.Error(), loc)
|
|
||||||
}
|
|
||||||
return ®expcond{re}, err
|
|
||||||
}
|
|
||||||
|
|
@ -1,137 +0,0 @@
|
||||||
// Package sed implements the classic UNIX sed language in pure Go.
|
|
||||||
// The interface is very simple: a user compiles a program into an
|
|
||||||
// execution engine by calling New or NewQuiet. Then, the engine
|
|
||||||
// can Wrap() any io.Reader to lazily process the stream as you
|
|
||||||
// read from it.
|
|
||||||
//
|
|
||||||
// All classic sed commands are supported, but since the package
|
|
||||||
// uses Go's regexp package for the regular expressions, the syntax
|
|
||||||
// for regexps will not be the same as a typical UNIX sed. In other
|
|
||||||
// words, instead of: s|ab\(c*\)d|\1|g you would say: s|ab(c*)d|$1|g.
|
|
||||||
// So this is a Go-flavored sed, rather than a drop-in replacement for
|
|
||||||
// a UNIX sed. Depending on your tastes, you will either consider this
|
|
||||||
// an improvement or completely brain-dead.
|
|
||||||
package sed
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"bytes"
|
|
||||||
"strings"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Engine is the compiled instruction stream for a sed program.
|
|
||||||
// It is the main type that users of the go-sed library will
|
|
||||||
// interact with.
|
|
||||||
type Engine struct {
|
|
||||||
ins []instruction // the instruction stream
|
|
||||||
}
|
|
||||||
|
|
||||||
// vm is the virtual machine state for a running sed program.
|
|
||||||
type vm struct {
|
|
||||||
nxtl string // the next line
|
|
||||||
pat string // the pattern space, possibly nil
|
|
||||||
hold string // the hold buffer, possibly nil
|
|
||||||
appl *string // any lines we've been asked to 'a\'ppend, usually nil
|
|
||||||
overflow string // any overflow we might have accumulated
|
|
||||||
lastl bool // true if it's the last line
|
|
||||||
ins []instruction // the instruction stream
|
|
||||||
ip int // the current locaiton in the instruction stream
|
|
||||||
input *bufio.Reader // the input stream
|
|
||||||
output []byte // the output buffer
|
|
||||||
lineno int // current line number
|
|
||||||
modified bool // have we modified the pattern space?
|
|
||||||
}
|
|
||||||
|
|
||||||
// a sed instruction is mostly a function transforming an engine
|
|
||||||
type instruction func(*vm) error
|
|
||||||
|
|
||||||
// makeEngine is the logic behine the New and NewQuiet public functions.
|
|
||||||
// It lexes and parses the program, and makes a new Engine out of it.
|
|
||||||
func makeEngine(program io.Reader, isQuiet bool) (*Engine, error) {
|
|
||||||
bufprog := bufio.NewReader(program)
|
|
||||||
ch := make(chan *token, 128)
|
|
||||||
errch := make(chan error, 1)
|
|
||||||
go lex(bufprog, ch, errch)
|
|
||||||
|
|
||||||
instructions, parseErr := parse(ch, isQuiet)
|
|
||||||
var err = <-errch // look for lexing errors first...
|
|
||||||
if err == nil {
|
|
||||||
// if there were no lex errors, look for a parsing error
|
|
||||||
err = parseErr
|
|
||||||
}
|
|
||||||
|
|
||||||
return &Engine{ins: instructions}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// New creates a new sed engine from a program. The program is executed
|
|
||||||
// via the Run method. If the provided program has any errors, the returned
|
|
||||||
// engine will be 'nil' and the error will be returned. Otherwise, the returned
|
|
||||||
// error will be nil.
|
|
||||||
func New(program io.Reader) (*Engine, error) {
|
|
||||||
return makeEngine(program, false)
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewQuiet creates a new sed engine from a program. It behaves exactly as
|
|
||||||
// New(), except it produces an engine that doesn't print lines by defualt. This
|
|
||||||
// is the classic '-n' sed behaviour.
|
|
||||||
func NewQuiet(program io.Reader) (*Engine, error) {
|
|
||||||
return makeEngine(program, true)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Wrap supplies an io.Reader that applies the sed Engine to the given
|
|
||||||
// input. The sed program is run lazily against the input as the user
|
|
||||||
// asks for bytes. If you'd prefer to run all at once from string to
|
|
||||||
// string, use RunString instead.
|
|
||||||
func (e *Engine) Wrap(input io.Reader) io.Reader {
|
|
||||||
bufin := bufio.NewReader(input)
|
|
||||||
|
|
||||||
// prime the engine by resetting the internal flags and filling nxtl...
|
|
||||||
return &vm{ins: e.ins, input: bufin, lineno: -1, ip: -1}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Read turns a vm into an io.Reader.
|
|
||||||
func (v *vm) Read(p []byte) (int, error) {
|
|
||||||
var err error
|
|
||||||
v.output = p
|
|
||||||
|
|
||||||
if v.lineno == -1 {
|
|
||||||
// we have an uninitialized stream
|
|
||||||
err = cmd_fillNext(v)
|
|
||||||
v.ip = 0
|
|
||||||
} else if len(v.overflow) > 0 {
|
|
||||||
// we have overflow to work on
|
|
||||||
o := v.overflow
|
|
||||||
v.overflow = ""
|
|
||||||
err = writeString(v, o)
|
|
||||||
}
|
|
||||||
|
|
||||||
// run the program
|
|
||||||
for err == nil {
|
|
||||||
err = v.ins[v.ip](v)
|
|
||||||
}
|
|
||||||
|
|
||||||
var n int = len(p) - len(v.output)
|
|
||||||
|
|
||||||
if ((err == fullBuffer) || (err == io.EOF)) && (n > 0) {
|
|
||||||
err = nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return n, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// RunString executes the program embodied by the Engine on the
|
|
||||||
// given string as input, returning the output string and any
|
|
||||||
// errors that occured.
|
|
||||||
func (e *Engine) RunString(input string) (string, error) {
|
|
||||||
inbuf := strings.NewReader(input)
|
|
||||||
var outbytes bytes.Buffer
|
|
||||||
|
|
||||||
_, err := io.Copy(&outbytes, e.Wrap(inbuf))
|
|
||||||
|
|
||||||
if err == io.EOF {
|
|
||||||
err = nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return outbytes.String(), err
|
|
||||||
}
|
|
||||||
|
|
@ -1,325 +0,0 @@
|
||||||
package sed
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"io/ioutil"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
var fullBuffer = errors.New("FullBuffer")
|
|
||||||
|
|
||||||
func writeString(svm *vm, str string) error {
|
|
||||||
var err error
|
|
||||||
end := len(svm.output)
|
|
||||||
src := str
|
|
||||||
srclen := len(src)
|
|
||||||
if end < srclen {
|
|
||||||
src = src[:end]
|
|
||||||
srclen = end
|
|
||||||
svm.overflow += str[end:]
|
|
||||||
err = fullBuffer
|
|
||||||
}
|
|
||||||
for i := 0; i < srclen; i++ {
|
|
||||||
svm.output[i] = src[i]
|
|
||||||
}
|
|
||||||
|
|
||||||
svm.output = svm.output[srclen:]
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func cmd_quit(svm *vm) error {
|
|
||||||
return io.EOF
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_swap(svm *vm) error {
|
|
||||||
svm.pat, svm.hold = svm.hold, svm.pat
|
|
||||||
svm.ip++
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_get(svm *vm) error {
|
|
||||||
svm.pat = svm.hold
|
|
||||||
svm.ip++
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_hold(svm *vm) error {
|
|
||||||
svm.hold = svm.pat
|
|
||||||
svm.ip++
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_getapp(svm *vm) error {
|
|
||||||
svm.pat = strings.Join([]string{svm.pat, svm.hold}, "\n")
|
|
||||||
svm.ip++
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_holdapp(svm *vm) error {
|
|
||||||
svm.hold = strings.Join([]string{svm.hold, svm.pat}, "\n")
|
|
||||||
svm.ip++
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
// newBranch generates branch instructions with specific
|
|
||||||
// targets
|
|
||||||
func cmd_newBranch(target int) instruction {
|
|
||||||
return func(svm *vm) error {
|
|
||||||
svm.ip = target
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
// newChangedBranch generates branch instructions with specific
|
|
||||||
// targets that only trigger on modified pattern spaces
|
|
||||||
func cmd_newChangedBranch(target int) instruction {
|
|
||||||
return func(svm *vm) error {
|
|
||||||
if svm.modified {
|
|
||||||
svm.ip = target
|
|
||||||
svm.modified = false
|
|
||||||
} else {
|
|
||||||
svm.ip++
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_print(svm *vm) error {
|
|
||||||
svm.ip++
|
|
||||||
|
|
||||||
writeString(svm, svm.pat)
|
|
||||||
return writeString(svm, "\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_printFirstLine(svm *vm) error {
|
|
||||||
svm.ip++
|
|
||||||
|
|
||||||
idx := strings.IndexRune(svm.pat, '\n')
|
|
||||||
|
|
||||||
if idx == -1 {
|
|
||||||
idx = len(svm.pat)
|
|
||||||
}
|
|
||||||
|
|
||||||
writeString(svm, svm.pat[:idx])
|
|
||||||
return writeString(svm, "\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_deleteFirstLine(svm *vm) (err error) {
|
|
||||||
idx := strings.IndexRune(svm.pat, '\n')
|
|
||||||
|
|
||||||
if idx == -1 {
|
|
||||||
svm.pat = ""
|
|
||||||
svm.ip = 0 // go back and fillNext
|
|
||||||
} else {
|
|
||||||
svm.pat = svm.pat[idx+1:]
|
|
||||||
svm.ip = 1 // restart, but skip filling
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_lineno(svm *vm) error {
|
|
||||||
svm.ip++
|
|
||||||
var lineno = fmt.Sprintf("%d\n", svm.lineno)
|
|
||||||
return writeString(svm, lineno)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ---------------------------------------------------
|
|
||||||
func cmd_fillNext(svm *vm) error {
|
|
||||||
var err error
|
|
||||||
|
|
||||||
// first, put out any stored-up 'a\'ppended text:
|
|
||||||
if svm.appl != nil {
|
|
||||||
err = writeString(svm, *svm.appl)
|
|
||||||
svm.appl = nil
|
|
||||||
if err != nil {
|
|
||||||
return err // ok, since IP unchanged
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// just return if we're at EOF
|
|
||||||
if svm.lastl {
|
|
||||||
return io.EOF
|
|
||||||
}
|
|
||||||
|
|
||||||
// otherwise, copy nxtl to the pattern space and
|
|
||||||
// refill.
|
|
||||||
svm.ip++
|
|
||||||
|
|
||||||
svm.pat = svm.nxtl
|
|
||||||
svm.lineno++
|
|
||||||
svm.modified = false
|
|
||||||
|
|
||||||
var prefix = true
|
|
||||||
var line []byte
|
|
||||||
|
|
||||||
var lines []string
|
|
||||||
|
|
||||||
for prefix {
|
|
||||||
line, prefix, err = svm.input.ReadLine()
|
|
||||||
if err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
// buf := make([]byte, len(line))
|
|
||||||
// copy(buf, line)
|
|
||||||
lines = append(lines, string(line))
|
|
||||||
}
|
|
||||||
|
|
||||||
svm.nxtl = strings.Join(lines, "")
|
|
||||||
|
|
||||||
if err == io.EOF {
|
|
||||||
if len(svm.nxtl) == 0 {
|
|
||||||
svm.lastl = true
|
|
||||||
}
|
|
||||||
err = nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func cmd_fillNextAppend(svm *vm) error {
|
|
||||||
var lines = make([]string, 2)
|
|
||||||
lines[0] = svm.pat
|
|
||||||
err := cmd_fillNext(svm) // increments svm.ip, so we don't
|
|
||||||
lines[1] = svm.pat
|
|
||||||
svm.pat = strings.Join(lines, "\n")
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// --------------------------------------------------
|
|
||||||
|
|
||||||
type cmd_simplecond struct {
|
|
||||||
cond condition // the condition to check
|
|
||||||
metloc int // where to jump if the condition is met
|
|
||||||
unmetloc int // where to jump if the condition is not met
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *cmd_simplecond) run(svm *vm) error {
|
|
||||||
if c.cond.isMet(svm) {
|
|
||||||
svm.ip = c.metloc
|
|
||||||
} else {
|
|
||||||
svm.ip = c.unmetloc
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// --------------------------------------------------
|
|
||||||
type cmd_twocond struct {
|
|
||||||
start condition // the condition that begines the block
|
|
||||||
end condition // the condition that ends the block
|
|
||||||
metloc int // where to jump if the condition is met
|
|
||||||
unmetloc int // where to jump if the condition is not met
|
|
||||||
isOn bool // are we active already?
|
|
||||||
offFrom int // if we saw the end condition, what line was it on?
|
|
||||||
}
|
|
||||||
|
|
||||||
func newTwoCond(c1 condition, c2 condition, metloc int, unmetloc int) *cmd_twocond {
|
|
||||||
return &cmd_twocond{c1, c2, metloc, unmetloc, false, 0}
|
|
||||||
}
|
|
||||||
|
|
||||||
// isLastLine is here to support multi-line "c\" commands.
|
|
||||||
// The command needs to know when it's the end of the
|
|
||||||
// section so it can do the replacement.
|
|
||||||
func (c *cmd_twocond) isLastLine(svm *vm) bool {
|
|
||||||
return c.isOn && (c.offFrom == svm.lineno)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *cmd_twocond) run(svm *vm) error {
|
|
||||||
if c.isOn && (c.offFrom > 0) && (c.offFrom < svm.lineno) {
|
|
||||||
c.isOn = false
|
|
||||||
c.offFrom = 0
|
|
||||||
}
|
|
||||||
|
|
||||||
if !c.isOn {
|
|
||||||
if c.start.isMet(svm) {
|
|
||||||
svm.ip = c.metloc
|
|
||||||
c.isOn = true
|
|
||||||
} else {
|
|
||||||
svm.ip = c.unmetloc
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if c.end.isMet(svm) {
|
|
||||||
c.offFrom = svm.lineno
|
|
||||||
}
|
|
||||||
svm.ip = c.metloc
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// --------------------------------------------------
|
|
||||||
func cmd_newChanger(text string, guard *cmd_twocond) instruction {
|
|
||||||
return func(svm *vm) error {
|
|
||||||
svm.ip = 0 // go to the the next cycle
|
|
||||||
|
|
||||||
var err error
|
|
||||||
if (guard == nil) || guard.isLastLine(svm) {
|
|
||||||
err = writeString(svm, text)
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// --------------------------------------------------
|
|
||||||
func cmd_newAppender(text string) instruction {
|
|
||||||
return func(svm *vm) error {
|
|
||||||
svm.ip++
|
|
||||||
if svm.appl == nil {
|
|
||||||
svm.appl = &text
|
|
||||||
} else {
|
|
||||||
var newstr = *svm.appl + text
|
|
||||||
svm.appl = &newstr
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// --------------------------------------------------
|
|
||||||
func cmd_newInserter(text string) instruction {
|
|
||||||
return func(svm *vm) error {
|
|
||||||
svm.ip++
|
|
||||||
return writeString(svm, text)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// --------------------------------------------------
|
|
||||||
// The 'r' command is basically and 'a\' with the contents
|
|
||||||
// of a filsvm. I implement it literally that way below.
|
|
||||||
func cmd_newReader(filename string) (instruction, error) {
|
|
||||||
bytes, err := ioutil.ReadFile(filename)
|
|
||||||
return cmd_newAppender(string(bytes)), err
|
|
||||||
}
|
|
||||||
|
|
||||||
// --------------------------------------------------
|
|
||||||
// The 'w' command appends the current pattern space
|
|
||||||
// to the named filsvm. In this implementation, it opens
|
|
||||||
// the file for appending, writes the file, and then
|
|
||||||
// closes the filsvm. This appears to be consistent with
|
|
||||||
// what OS X sed does.
|
|
||||||
func cmd_newWriter(filename string) instruction {
|
|
||||||
return func(svm *vm) error {
|
|
||||||
svm.ip++
|
|
||||||
f, err := os.OpenFile(filename, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
|
|
||||||
if err == nil {
|
|
||||||
defer f.Close()
|
|
||||||
_, err = f.WriteString(svm.pat)
|
|
||||||
}
|
|
||||||
if err == nil {
|
|
||||||
_, err = f.WriteString("\n")
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,441 +0,0 @@
|
||||||
package sed
|
|
||||||
|
|
||||||
// the lexer for SED. The point of the lexer is to
|
|
||||||
// reliably transform the input into a series of token structs.
|
|
||||||
// These structs know the source location, and the token type, and
|
|
||||||
// any arguments to the token (e.g., a regexp's '/' argument is the
|
|
||||||
// regular expression itself).
|
|
||||||
//
|
|
||||||
// The lexer also simplifies and regularises the input, for instance
|
|
||||||
// by eliminating comments.
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"bytes"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
"unicode"
|
|
||||||
)
|
|
||||||
|
|
||||||
type location struct {
|
|
||||||
line int
|
|
||||||
pos int
|
|
||||||
}
|
|
||||||
|
|
||||||
func (l *location) String() string {
|
|
||||||
return fmt.Sprintf("at line %d, pos %d", l.line, l.pos)
|
|
||||||
}
|
|
||||||
|
|
||||||
const (
|
|
||||||
tok_NUM = iota
|
|
||||||
tok_RX
|
|
||||||
tok_COMMA
|
|
||||||
tok_BANG
|
|
||||||
tok_DOLLAR
|
|
||||||
tok_LBRACE
|
|
||||||
tok_RBRACE
|
|
||||||
tok_EOL
|
|
||||||
tok_CMD
|
|
||||||
tok_CHANGE
|
|
||||||
tok_LABEL
|
|
||||||
)
|
|
||||||
|
|
||||||
type token struct {
|
|
||||||
location
|
|
||||||
typ int
|
|
||||||
letter rune
|
|
||||||
args []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// ----------------------------------------------------------
|
|
||||||
// Location-tracking reader
|
|
||||||
// ----------------------------------------------------------
|
|
||||||
type locReader struct {
|
|
||||||
location
|
|
||||||
eol bool // state for end of line, true when last rune was '\n'
|
|
||||||
r *bufio.Reader
|
|
||||||
}
|
|
||||||
|
|
||||||
func (lr *locReader) ReadRune() (rune, int, error) {
|
|
||||||
r, i, err := lr.r.ReadRune()
|
|
||||||
|
|
||||||
lr.pos++
|
|
||||||
|
|
||||||
if lr.eol {
|
|
||||||
lr.pos = 1
|
|
||||||
lr.line++
|
|
||||||
lr.eol = false
|
|
||||||
}
|
|
||||||
if r == '\n' {
|
|
||||||
lr.eol = true
|
|
||||||
}
|
|
||||||
|
|
||||||
return r, i, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (lr *locReader) UnreadRune() error {
|
|
||||||
lr.pos--
|
|
||||||
lr.eol = false
|
|
||||||
|
|
||||||
if lr.pos == 0 {
|
|
||||||
lr.line--
|
|
||||||
lr.eol = true
|
|
||||||
}
|
|
||||||
return lr.r.UnreadRune()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (lr *locReader) ReadLine() (nxtl string, err error) {
|
|
||||||
var prefix = true
|
|
||||||
var line []byte
|
|
||||||
|
|
||||||
var lines []string
|
|
||||||
|
|
||||||
for prefix {
|
|
||||||
line, prefix, err = lr.r.ReadLine()
|
|
||||||
if err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
buf := make([]byte, len(line))
|
|
||||||
copy(buf, line)
|
|
||||||
lines = append(lines, string(buf))
|
|
||||||
}
|
|
||||||
|
|
||||||
nxtl = strings.Join(lines, "")
|
|
||||||
|
|
||||||
// fixup our position information
|
|
||||||
lr.pos += len(nxtl)
|
|
||||||
lr.eol = true
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// ----------------------------------------------------------
|
|
||||||
// lexer functions
|
|
||||||
// ----------------------------------------------------------
|
|
||||||
func skipComment(r *locReader) (rune, error) {
|
|
||||||
var err error
|
|
||||||
var cur rune = ' '
|
|
||||||
for (cur != '\n') && (err == nil) {
|
|
||||||
cur, _, err = r.ReadRune()
|
|
||||||
}
|
|
||||||
return ';', err
|
|
||||||
}
|
|
||||||
|
|
||||||
func skipWS(r *locReader) (rune, error) {
|
|
||||||
var err error
|
|
||||||
var cur rune = ' '
|
|
||||||
for {
|
|
||||||
switch {
|
|
||||||
case cur == '\n':
|
|
||||||
return ';', err
|
|
||||||
case cur == '#':
|
|
||||||
return skipComment(r)
|
|
||||||
case !unicode.IsSpace(cur):
|
|
||||||
return cur, err
|
|
||||||
}
|
|
||||||
cur, _, err = r.ReadRune()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func readNumber(r *locReader, character rune) (string, error) {
|
|
||||||
var buffer bytes.Buffer
|
|
||||||
|
|
||||||
var err error
|
|
||||||
for (err == nil) && unicode.IsDigit(character) {
|
|
||||||
buffer.WriteRune(character)
|
|
||||||
character, _, err = r.ReadRune()
|
|
||||||
}
|
|
||||||
|
|
||||||
if err == nil {
|
|
||||||
err = r.UnreadRune()
|
|
||||||
}
|
|
||||||
|
|
||||||
return buffer.String(), err
|
|
||||||
}
|
|
||||||
|
|
||||||
// readDelimited reads until it finds the delimter character,
|
|
||||||
// returning the string (not including the delimiter). It does
|
|
||||||
// allow the delimiter to be escaped by a backslash ('\').
|
|
||||||
// It is an error to reach EOL while looking for the delimiter.
|
|
||||||
func readDelimited(r *locReader, delimiter rune) (string, error) {
|
|
||||||
var buffer bytes.Buffer
|
|
||||||
|
|
||||||
var err error
|
|
||||||
var character rune
|
|
||||||
var previous rune
|
|
||||||
|
|
||||||
character, _, err = r.ReadRune()
|
|
||||||
for (err == nil) &&
|
|
||||||
(character != '\n') &&
|
|
||||||
((character != delimiter) || (previous == '\\')) {
|
|
||||||
buffer.WriteRune(character)
|
|
||||||
previous = character
|
|
||||||
character, _, err = r.ReadRune()
|
|
||||||
}
|
|
||||||
|
|
||||||
if character == '\n' {
|
|
||||||
err = fmt.Errorf("end-of-line while looking for %c", delimiter)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err == io.EOF {
|
|
||||||
err = fmt.Errorf("end-of-file while looking for %c", delimiter)
|
|
||||||
}
|
|
||||||
|
|
||||||
return buffer.String(), err
|
|
||||||
}
|
|
||||||
|
|
||||||
// readReplacement reads until it finds the delimter character,
|
|
||||||
// returning the string (not including the delimiter). It does
|
|
||||||
// allow the delimiter to be escaped by a backslash ('\'), and it
|
|
||||||
// does interpret a few common backslash escapes like \n and \t.
|
|
||||||
// It is an error to reach an unescaped EOL while looking for the delimiter.
|
|
||||||
func readReplacement(r *locReader, delimiter rune) (string, error) {
|
|
||||||
var buffer bytes.Buffer
|
|
||||||
|
|
||||||
var err error
|
|
||||||
var character rune
|
|
||||||
var previous rune
|
|
||||||
|
|
||||||
character, _, err = r.ReadRune()
|
|
||||||
for err == nil {
|
|
||||||
if character == '\r' {
|
|
||||||
character, _, err = r.ReadRune()
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if previous == '\\' {
|
|
||||||
// find out what we escaped...
|
|
||||||
switch character {
|
|
||||||
case 'r':
|
|
||||||
buffer.WriteRune('\r')
|
|
||||||
case 't':
|
|
||||||
buffer.WriteRune('\t')
|
|
||||||
case 'n':
|
|
||||||
buffer.WriteRune('\n')
|
|
||||||
case '\\':
|
|
||||||
buffer.WriteRune(character)
|
|
||||||
character = ' ' // don't escape the next one
|
|
||||||
default:
|
|
||||||
buffer.WriteRune(character)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if character == delimiter ||
|
|
||||||
character == '\n' {
|
|
||||||
break
|
|
||||||
} else if character != '\\' {
|
|
||||||
buffer.WriteRune(character)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
previous = character
|
|
||||||
character, _, err = r.ReadRune()
|
|
||||||
}
|
|
||||||
|
|
||||||
if character == '\n' {
|
|
||||||
err = fmt.Errorf("end-of-line while looking for %c", delimiter)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err == io.EOF {
|
|
||||||
err = fmt.Errorf("end-of-file while looking for %c", delimiter)
|
|
||||||
}
|
|
||||||
|
|
||||||
return buffer.String(), err
|
|
||||||
}
|
|
||||||
|
|
||||||
// readMultiLine reads until it finds an unescaped newline. It discards the
|
|
||||||
// first line, if it is empty, because commands like "c\", "a\" and "i\" are
|
|
||||||
// intended to be used that way.
|
|
||||||
func readMultiLine(r *locReader) (string, error) {
|
|
||||||
var lines []string
|
|
||||||
var err error
|
|
||||||
|
|
||||||
first := true
|
|
||||||
hasSlash := true // does the line end in a slash?
|
|
||||||
|
|
||||||
for hasSlash {
|
|
||||||
txt, err := r.ReadLine()
|
|
||||||
if err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
tlen := len(txt)
|
|
||||||
|
|
||||||
// strip off the final '\', if there is one
|
|
||||||
if tlen > 0 && txt[tlen-1] == '\\' {
|
|
||||||
txt = txt[:tlen-1]
|
|
||||||
} else {
|
|
||||||
hasSlash = false
|
|
||||||
}
|
|
||||||
|
|
||||||
// If it's empty and the first line, forget it.
|
|
||||||
// Otherwise, add it to the line list
|
|
||||||
if !first || tlen > 1 {
|
|
||||||
lines = append(lines, txt)
|
|
||||||
}
|
|
||||||
|
|
||||||
first = false
|
|
||||||
}
|
|
||||||
|
|
||||||
// for sed's purposes, we want a final newline...
|
|
||||||
lines = append(lines, "")
|
|
||||||
|
|
||||||
return strings.Join(lines, "\n"), err
|
|
||||||
}
|
|
||||||
|
|
||||||
// readIdentifier skips any whitespace, and then reads until it
|
|
||||||
// finds either a ';' or a non-alphanumeric character. It
|
|
||||||
// returns the string it reads.
|
|
||||||
func readIdentifier(r *locReader) (string, error) {
|
|
||||||
var buffer bytes.Buffer
|
|
||||||
|
|
||||||
var err error
|
|
||||||
var character rune
|
|
||||||
|
|
||||||
character, err = skipWS(r)
|
|
||||||
for (err == nil) && (character != ';') && !unicode.IsSpace(character) {
|
|
||||||
buffer.WriteRune(character)
|
|
||||||
character, _, err = r.ReadRune()
|
|
||||||
}
|
|
||||||
|
|
||||||
if err == nil {
|
|
||||||
err = r.UnreadRune()
|
|
||||||
}
|
|
||||||
return buffer.String(), err
|
|
||||||
}
|
|
||||||
|
|
||||||
func readSubstitution(r *locReader) ([]string, error) {
|
|
||||||
var ans = make([]string, 3)
|
|
||||||
var err error
|
|
||||||
|
|
||||||
// step 1.: get the delimiter character for substitutions
|
|
||||||
var delimiter rune
|
|
||||||
delimiter, _, err = r.ReadRune()
|
|
||||||
if err != nil {
|
|
||||||
return ans, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// step 2.: read the regexp
|
|
||||||
ans[0], err = readDelimited(r, delimiter)
|
|
||||||
if err != nil {
|
|
||||||
return ans, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// step 3.: read the replacement
|
|
||||||
ans[1], err = readReplacement(r, delimiter)
|
|
||||||
if err != nil {
|
|
||||||
return ans, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// step 4.: read the modifiers
|
|
||||||
ans[2], err = readIdentifier(r)
|
|
||||||
|
|
||||||
return ans, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func readTranslation(r *locReader) ([]string, error) {
|
|
||||||
var ans = make([]string, 2)
|
|
||||||
var err error
|
|
||||||
|
|
||||||
// step 1.: get the delimiter character for substitutions
|
|
||||||
var delimiter rune
|
|
||||||
delimiter, _, err = r.ReadRune()
|
|
||||||
if err != nil {
|
|
||||||
return ans, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// step 2.: read the regexp
|
|
||||||
ans[0], err = readDelimited(r, delimiter)
|
|
||||||
if err != nil {
|
|
||||||
return ans, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// step 3.: read the replacement
|
|
||||||
ans[1], err = readDelimited(r, delimiter)
|
|
||||||
if err != nil {
|
|
||||||
return ans, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return ans, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func lex(r *bufio.Reader, ch chan<- *token, errch chan<- error) {
|
|
||||||
defer close(ch)
|
|
||||||
defer close(errch)
|
|
||||||
|
|
||||||
rdr := locReader{}
|
|
||||||
rdr.r = r
|
|
||||||
rdr.eol = true
|
|
||||||
|
|
||||||
var err error
|
|
||||||
var cur rune
|
|
||||||
|
|
||||||
var topLoc = rdr.location
|
|
||||||
|
|
||||||
for err == nil {
|
|
||||||
cur, err = skipWS(&rdr)
|
|
||||||
if err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
topLoc = rdr.location // remember the start of the command
|
|
||||||
|
|
||||||
switch cur {
|
|
||||||
case ';':
|
|
||||||
ch <- &token{topLoc, tok_EOL, cur, nil}
|
|
||||||
case ',':
|
|
||||||
ch <- &token{topLoc, tok_COMMA, cur, nil}
|
|
||||||
case '{':
|
|
||||||
ch <- &token{topLoc, tok_LBRACE, cur, nil}
|
|
||||||
case '}':
|
|
||||||
ch <- &token{topLoc, tok_RBRACE, cur, nil}
|
|
||||||
case '!':
|
|
||||||
ch <- &token{topLoc, tok_BANG, cur, nil}
|
|
||||||
case '/':
|
|
||||||
var rx string
|
|
||||||
rx, err = readDelimited(&rdr, '/')
|
|
||||||
ch <- &token{topLoc, tok_RX, cur, []string{rx}}
|
|
||||||
case '$':
|
|
||||||
ch <- &token{topLoc, tok_DOLLAR, cur, nil}
|
|
||||||
case ':':
|
|
||||||
var label string
|
|
||||||
label, err = readIdentifier(&rdr)
|
|
||||||
ch <- &token{topLoc, tok_LABEL, cur, []string{label}}
|
|
||||||
case 'b', 't': // branches...
|
|
||||||
var label string
|
|
||||||
label, err = readIdentifier(&rdr)
|
|
||||||
ch <- &token{topLoc, tok_CMD, cur, []string{label}}
|
|
||||||
case 's': // substitution
|
|
||||||
var args []string
|
|
||||||
args, err = readSubstitution(&rdr)
|
|
||||||
ch <- &token{topLoc, tok_CMD, cur, args}
|
|
||||||
case 'y': // translation
|
|
||||||
var args []string
|
|
||||||
args, err = readTranslation(&rdr)
|
|
||||||
ch <- &token{topLoc, tok_CMD, cur, args}
|
|
||||||
case 'c': // change
|
|
||||||
var txt string
|
|
||||||
txt, err = readMultiLine(&rdr)
|
|
||||||
ch <- &token{topLoc, tok_CHANGE, cur, []string{txt}}
|
|
||||||
case 'i', 'a': // insert or append
|
|
||||||
var txt string
|
|
||||||
txt, err = readMultiLine(&rdr)
|
|
||||||
ch <- &token{topLoc, tok_CMD, cur, []string{txt}}
|
|
||||||
case 'r', 'w':
|
|
||||||
var fname string
|
|
||||||
fname, err = readIdentifier(&rdr)
|
|
||||||
ch <- &token{topLoc, tok_CMD, cur, []string{fname}}
|
|
||||||
default:
|
|
||||||
if unicode.IsDigit(cur) {
|
|
||||||
var num string
|
|
||||||
num, err = readNumber(&rdr, cur)
|
|
||||||
ch <- &token{topLoc, tok_NUM, cur, []string{num}}
|
|
||||||
} else {
|
|
||||||
// it's just a argument-free command
|
|
||||||
ch <- &token{topLoc, tok_CMD, cur, nil}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != io.EOF {
|
|
||||||
errch <- fmt.Errorf("Error reading... <%s> %v", err.Error(), &topLoc)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,331 +0,0 @@
|
||||||
package sed
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"strconv"
|
|
||||||
)
|
|
||||||
|
|
||||||
// these functions parse the lex'ed tokens (lex.go) and
|
|
||||||
// build a program for the engine (engine.go) to run.
|
|
||||||
|
|
||||||
var zeroBranch = cmd_newBranch(0)
|
|
||||||
|
|
||||||
type waitingBranch struct {
|
|
||||||
ip int // address of the branch to fix up
|
|
||||||
label string // the target label
|
|
||||||
letter rune // 'b' or 't' branch
|
|
||||||
loc *location // the original parse location
|
|
||||||
}
|
|
||||||
|
|
||||||
const (
|
|
||||||
end_of_program_label = "the end" // has a space... no conflicts with user labels
|
|
||||||
)
|
|
||||||
|
|
||||||
type parseState struct {
|
|
||||||
toks <-chan *token // our input
|
|
||||||
ins []instruction // the compiled instructions
|
|
||||||
branches []waitingBranch // references to fix up
|
|
||||||
b_labels map[string]instruction // named b branch labels
|
|
||||||
t_labels map[string]instruction // named t branch labels
|
|
||||||
blockLevel int // how deeply nested are our blocks?
|
|
||||||
quiet bool // are we building a quiet engine (-n sed)?
|
|
||||||
err error // record any errors we encounter
|
|
||||||
}
|
|
||||||
|
|
||||||
func parse(input <-chan *token, quiet bool) ([]instruction, error) {
|
|
||||||
ps := &parseState{toks: input, b_labels: make(map[string]instruction), t_labels: make(map[string]instruction), quiet: quiet}
|
|
||||||
|
|
||||||
ps.ins = append(ps.ins, cmd_fillNext)
|
|
||||||
parse_toplevel(ps)
|
|
||||||
if ps.err == nil && ps.blockLevel > 0 {
|
|
||||||
ps.err = fmt.Errorf("It looks like you are missing a closing brace!")
|
|
||||||
}
|
|
||||||
|
|
||||||
// if the parsing failed in some way, just give up now
|
|
||||||
if ps.err != nil {
|
|
||||||
return nil, ps.err
|
|
||||||
}
|
|
||||||
|
|
||||||
ps.b_labels[end_of_program_label] = cmd_newBranch(len(ps.ins))
|
|
||||||
ps.t_labels[end_of_program_label] = cmd_newChangedBranch(len(ps.ins))
|
|
||||||
if !ps.quiet {
|
|
||||||
ps.ins = append(ps.ins, cmd_print)
|
|
||||||
}
|
|
||||||
ps.ins = append(ps.ins, zeroBranch)
|
|
||||||
parse_resolveBranches(ps)
|
|
||||||
|
|
||||||
return ps.ins, ps.err
|
|
||||||
}
|
|
||||||
|
|
||||||
func parse_resolveBranches(ps *parseState) {
|
|
||||||
waiting := ps.branches
|
|
||||||
for idx := range waiting {
|
|
||||||
var (
|
|
||||||
ins instruction
|
|
||||||
ok bool
|
|
||||||
)
|
|
||||||
if waiting[idx].letter == 'b' {
|
|
||||||
ins, ok = ps.b_labels[waiting[idx].label]
|
|
||||||
} else {
|
|
||||||
ins, ok = ps.t_labels[waiting[idx].label]
|
|
||||||
}
|
|
||||||
if !ok {
|
|
||||||
ps.err = fmt.Errorf("unknown label %s %v", waiting[idx].label, waiting[idx].loc)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
ps.ins[waiting[idx].ip] = ins
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func parse_toplevel(ps *parseState) {
|
|
||||||
for tok := range ps.toks {
|
|
||||||
switch tok.typ {
|
|
||||||
case tok_CMD:
|
|
||||||
compile_cmd(ps, tok)
|
|
||||||
case tok_LABEL:
|
|
||||||
compile_label(ps, tok)
|
|
||||||
case tok_NUM:
|
|
||||||
n, err := strconv.Atoi(tok.args[0])
|
|
||||||
if err != nil {
|
|
||||||
ps.err = fmt.Errorf("Bad number <%s> %v", tok.args[0], &tok.location)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
compile_cond(ps, numbercond(n))
|
|
||||||
case tok_DOLLAR:
|
|
||||||
compile_cond(ps, eofcond{})
|
|
||||||
case tok_RX:
|
|
||||||
var rx condition
|
|
||||||
rx, ps.err = newRECondition(tok.args[0], &tok.location)
|
|
||||||
if ps.err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
compile_cond(ps, rx)
|
|
||||||
case tok_EOL:
|
|
||||||
// top level empty lines are OK
|
|
||||||
case tok_RBRACE:
|
|
||||||
if ps.blockLevel == 0 {
|
|
||||||
ps.err = fmt.Errorf("Unexpected brace %v", &tok.location)
|
|
||||||
}
|
|
||||||
ps.blockLevel--
|
|
||||||
return
|
|
||||||
default:
|
|
||||||
ps.err = fmt.Errorf("Unexpected token '%c' %v", tok.letter, &tok.location)
|
|
||||||
}
|
|
||||||
if ps.err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func mustGetToken(ps *parseState) (t *token, ok bool) {
|
|
||||||
t, ok = <-ps.toks
|
|
||||||
if !ok {
|
|
||||||
ps.err = fmt.Errorf("Unexpected end of script!")
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// compile_cond operates when we see a condition. It looks for
|
|
||||||
// a closing condition and an inverter '!'
|
|
||||||
func compile_cond(ps *parseState, c condition) {
|
|
||||||
tok, ok := mustGetToken(ps)
|
|
||||||
if !ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
switch tok.typ {
|
|
||||||
case tok_COMMA:
|
|
||||||
compile_twocond(ps, c)
|
|
||||||
case tok_BANG:
|
|
||||||
tok, ok = mustGetToken(ps)
|
|
||||||
if !ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
sc := &cmd_simplecond{c, 0, len(ps.ins) + 1}
|
|
||||||
ps.ins = append(ps.ins, sc.run)
|
|
||||||
compile_block(ps, tok)
|
|
||||||
sc.metloc = len(ps.ins)
|
|
||||||
default:
|
|
||||||
sc := &cmd_simplecond{c, len(ps.ins) + 1, 0}
|
|
||||||
ps.ins = append(ps.ins, sc.run)
|
|
||||||
compile_block(ps, tok)
|
|
||||||
sc.unmetloc = len(ps.ins)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// compile_twocond operates when we have a comma-separated
|
|
||||||
// pair of conditions, and we are expecting to read the second
|
|
||||||
// condition next.
|
|
||||||
func compile_twocond(ps *parseState, c1 condition) {
|
|
||||||
tok, ok := mustGetToken(ps)
|
|
||||||
if !ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
var c2 condition
|
|
||||||
|
|
||||||
switch tok.typ {
|
|
||||||
case tok_NUM:
|
|
||||||
n, err := strconv.Atoi(tok.args[0])
|
|
||||||
if err != nil {
|
|
||||||
ps.err = fmt.Errorf("Bad number <%s> %v", tok.args[0], &tok.location)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
c2 = numbercond(n)
|
|
||||||
case tok_DOLLAR:
|
|
||||||
c2 = eofcond{}
|
|
||||||
case tok_RX:
|
|
||||||
c2, ps.err = newRECondition(tok.args[0], &tok.location)
|
|
||||||
if ps.err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
ps.err = fmt.Errorf("Expected a second condition after comma %v", &tok.location)
|
|
||||||
}
|
|
||||||
|
|
||||||
if ps.err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// now, we need to get the next token to determine if we're inverting
|
|
||||||
// the condition...
|
|
||||||
tok, ok = mustGetToken(ps)
|
|
||||||
if !ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
switch tok.typ {
|
|
||||||
case tok_BANG:
|
|
||||||
tok, ok = mustGetToken(ps)
|
|
||||||
if !ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
tc := newTwoCond(c1, c2, 0, len(ps.ins)+1)
|
|
||||||
ps.ins = append(ps.ins, tc.run)
|
|
||||||
compile_block(ps, tok)
|
|
||||||
tc.metloc = len(ps.ins)
|
|
||||||
case tok_CHANGE:
|
|
||||||
// special case for 2-condition change command...
|
|
||||||
// it has to be able to talk to the condition
|
|
||||||
// to know when it's the last line of the change
|
|
||||||
tc := newTwoCond(c1, c2, len(ps.ins)+1, 0)
|
|
||||||
ps.ins = append(ps.ins, tc.run, cmd_newChanger(tok.args[0], tc))
|
|
||||||
tc.unmetloc = len(ps.ins)
|
|
||||||
default:
|
|
||||||
tc := newTwoCond(c1, c2, len(ps.ins)+1, 0)
|
|
||||||
ps.ins = append(ps.ins, tc.run)
|
|
||||||
compile_block(ps, tok)
|
|
||||||
tc.unmetloc = len(ps.ins)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// compile_block parses a top-level block if it gets a
|
|
||||||
// LBRACE, or parses a single CMD as a block otherwise.
|
|
||||||
// Anything other than LBRACE or CMD is not allowed here.
|
|
||||||
func compile_block(ps *parseState, cmd *token) {
|
|
||||||
switch cmd.typ {
|
|
||||||
case tok_LBRACE:
|
|
||||||
ps.blockLevel++
|
|
||||||
parse_toplevel(ps)
|
|
||||||
case tok_CMD, tok_CHANGE:
|
|
||||||
compile_cmd(ps, cmd)
|
|
||||||
default:
|
|
||||||
ps.err = fmt.Errorf("Unexpected token '%c' at start of block %v", cmd.letter, &cmd.location)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// compile_cmd compiles the individual sed commands
|
|
||||||
// into instructions.
|
|
||||||
func compile_cmd(ps *parseState, cmd *token) {
|
|
||||||
switch cmd.letter {
|
|
||||||
case '=':
|
|
||||||
ps.ins = append(ps.ins, cmd_lineno)
|
|
||||||
case 'D':
|
|
||||||
ps.ins = append(ps.ins, cmd_deleteFirstLine)
|
|
||||||
case 'G':
|
|
||||||
ps.ins = append(ps.ins, cmd_getapp)
|
|
||||||
case 'H':
|
|
||||||
ps.ins = append(ps.ins, cmd_holdapp)
|
|
||||||
case 'N':
|
|
||||||
ps.ins = append(ps.ins, cmd_fillNextAppend)
|
|
||||||
case 'P':
|
|
||||||
ps.ins = append(ps.ins, cmd_printFirstLine)
|
|
||||||
case 'a':
|
|
||||||
ps.ins = append(ps.ins, cmd_newAppender(cmd.args[0]))
|
|
||||||
case 'b', 't':
|
|
||||||
compile_branchTarget(ps, len(ps.ins), cmd)
|
|
||||||
ps.ins = append(ps.ins, zeroBranch) // placeholder
|
|
||||||
case 'c':
|
|
||||||
ps.ins = append(ps.ins, cmd_newChanger(cmd.args[0], nil))
|
|
||||||
case 'd':
|
|
||||||
ps.ins = append(ps.ins, zeroBranch)
|
|
||||||
case 'g':
|
|
||||||
ps.ins = append(ps.ins, cmd_get)
|
|
||||||
case 'h':
|
|
||||||
ps.ins = append(ps.ins, cmd_hold)
|
|
||||||
case 'i':
|
|
||||||
ps.ins = append(ps.ins, cmd_newInserter(cmd.args[0]))
|
|
||||||
case 'n':
|
|
||||||
if !ps.quiet {
|
|
||||||
ps.ins = append(ps.ins, cmd_print)
|
|
||||||
}
|
|
||||||
ps.ins = append(ps.ins, cmd_fillNext)
|
|
||||||
case 'p':
|
|
||||||
ps.ins = append(ps.ins, cmd_print)
|
|
||||||
case 'q':
|
|
||||||
if !ps.quiet {
|
|
||||||
ps.ins = append(ps.ins, cmd_print)
|
|
||||||
}
|
|
||||||
ps.ins = append(ps.ins, cmd_quit)
|
|
||||||
case 'r':
|
|
||||||
reader, err := cmd_newReader(cmd.args[0])
|
|
||||||
if err != nil {
|
|
||||||
ps.err = fmt.Errorf("'r' command parse: %s %v", err.Error(), &cmd.location)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
ps.ins = append(ps.ins, reader)
|
|
||||||
case 's':
|
|
||||||
subst, err := newSubstitution(cmd.args[0], cmd.args[1], cmd.args[2])
|
|
||||||
if err != nil {
|
|
||||||
ps.err = fmt.Errorf("Substitution parse: %s %v", err.Error(), &cmd.location)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
ps.ins = append(ps.ins, subst)
|
|
||||||
case 'w':
|
|
||||||
ps.ins = append(ps.ins, cmd_newWriter(cmd.args[0]))
|
|
||||||
case 'x':
|
|
||||||
ps.ins = append(ps.ins, cmd_swap)
|
|
||||||
case 'y':
|
|
||||||
trans, err := newTranslation(cmd.args[0], cmd.args[1])
|
|
||||||
if err != nil {
|
|
||||||
ps.err = fmt.Errorf("Translation parse: %s %v", err.Error(), &cmd.location)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
ps.ins = append(ps.ins, trans)
|
|
||||||
default:
|
|
||||||
ps.err = fmt.Errorf("Unknown command '%c' %v", cmd.letter, &cmd.location)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func compile_branchTarget(ps *parseState, ip int, cmd *token) {
|
|
||||||
label := cmd.args[0]
|
|
||||||
if len(label) == 0 {
|
|
||||||
label = end_of_program_label
|
|
||||||
}
|
|
||||||
|
|
||||||
ps.branches = append(ps.branches, waitingBranch{ip, label, cmd.letter, &cmd.location})
|
|
||||||
}
|
|
||||||
|
|
||||||
func compile_label(ps *parseState, lbl *token) {
|
|
||||||
name := lbl.args[0]
|
|
||||||
if len(name) == 0 {
|
|
||||||
ps.err = fmt.Errorf("Bad label name %v", &lbl.location)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// store a branch instruction to jump to the current location.
|
|
||||||
// They will be inserted into the instruction stream in
|
|
||||||
// the parse_resolveBranches function.
|
|
||||||
ps.b_labels[name] = cmd_newBranch(len(ps.ins))
|
|
||||||
ps.t_labels[name] = cmd_newChangedBranch(len(ps.ins))
|
|
||||||
}
|
|
||||||
|
|
@ -1,138 +0,0 @@
|
||||||
package sed
|
|
||||||
|
|
||||||
// This file has the functionality for substitution and translation.
|
|
||||||
// They are the most complicated functions, so I didn't want
|
|
||||||
// to mix them in with the other instructions in instructions.go.
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"regexp"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"unicode/utf8"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ------------------------------------------------------------------
|
|
||||||
// - SUBSTITUTION -------------------------------------------------
|
|
||||||
// ------------------------------------------------------------------
|
|
||||||
type substitute struct {
|
|
||||||
pattern *regexp.Regexp // the pattern to match
|
|
||||||
replacement string // the template for replacements
|
|
||||||
which int // which pattern to replace
|
|
||||||
pflag bool // do we print upon replacement?
|
|
||||||
gflag bool // do we replace every match after 'which'?
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *substitute) run(svm *vm) (err error) {
|
|
||||||
svm.ip++
|
|
||||||
|
|
||||||
// perform the search
|
|
||||||
matches := s.pattern.FindAllStringSubmatchIndex(svm.pat, -1)
|
|
||||||
|
|
||||||
// filter to the matches we want to replace
|
|
||||||
var end int = len(matches)
|
|
||||||
if s.which < end {
|
|
||||||
if !s.gflag {
|
|
||||||
end = s.which + 1
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// the matches we want weren't found
|
|
||||||
return
|
|
||||||
}
|
|
||||||
matches = matches[s.which:end]
|
|
||||||
|
|
||||||
// perform the replacement
|
|
||||||
svm.pat = subst_replaceAll(svm.pat, s, matches)
|
|
||||||
svm.modified = true
|
|
||||||
|
|
||||||
// print if requested
|
|
||||||
if s.pflag {
|
|
||||||
err = cmd_print(svm)
|
|
||||||
svm.ip-- // roll back ip from the print command
|
|
||||||
}
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func subst_replaceAll(src string, subst *substitute, indexes [][]int) string {
|
|
||||||
var substrings []string
|
|
||||||
endpt := 0 // where we left off in the src string
|
|
||||||
for _, idx := range indexes {
|
|
||||||
exp := string(subst.pattern.ExpandString(nil, subst.replacement, src, idx))
|
|
||||||
substrings = append(substrings, src[endpt:idx[0]], exp)
|
|
||||||
endpt = idx[1]
|
|
||||||
}
|
|
||||||
substrings = append(substrings, src[endpt:])
|
|
||||||
|
|
||||||
return strings.Join(substrings, "")
|
|
||||||
}
|
|
||||||
|
|
||||||
func newSubstitution(pattern string, replacement string, mods string) (instruction, error) {
|
|
||||||
rx, err := regexp.Compile(pattern)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
command := &substitute{pattern: rx, replacement: replacement}
|
|
||||||
var numbers []rune
|
|
||||||
|
|
||||||
for _, char := range mods {
|
|
||||||
switch char {
|
|
||||||
case 'p':
|
|
||||||
command.pflag = true
|
|
||||||
case 'g':
|
|
||||||
command.gflag = true
|
|
||||||
case '0', '1', '2', '3', '4', '5', '6', '7', '8', '9':
|
|
||||||
numbers = append(numbers, char)
|
|
||||||
default:
|
|
||||||
err = fmt.Errorf("Bad regexp modifier <%v>", char)
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(numbers) > 0 {
|
|
||||||
command.which, _ = strconv.Atoi(string(numbers))
|
|
||||||
if command.which > 0 {
|
|
||||||
command.which--
|
|
||||||
} else {
|
|
||||||
err = fmt.Errorf("Bad number %d on substitution", command.which)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return command.run, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// ------------------------------------------------------------------
|
|
||||||
// - TRANSLATION --------------------------------------------------
|
|
||||||
// ------------------------------------------------------------------
|
|
||||||
func newTranslation(pattern string, replacement string) (instruction, error) {
|
|
||||||
rc1 := utf8.RuneCountInString(pattern)
|
|
||||||
rc2 := utf8.RuneCountInString(replacement)
|
|
||||||
if rc1 != rc2 {
|
|
||||||
return nil, fmt.Errorf("Translation 'y' pattern and replacement must be equal length")
|
|
||||||
}
|
|
||||||
|
|
||||||
// fill out repls array with alternating patterns and their replacements
|
|
||||||
var repls = make([]string, rc1+rc2)
|
|
||||||
idx := 0
|
|
||||||
for _, ch := range pattern {
|
|
||||||
repls[idx] = string(ch)
|
|
||||||
idx += 2
|
|
||||||
}
|
|
||||||
idx = 1
|
|
||||||
for _, ch := range replacement {
|
|
||||||
repls[idx] = string(ch)
|
|
||||||
idx += 2
|
|
||||||
}
|
|
||||||
|
|
||||||
stringReplacer := strings.NewReplacer(repls...)
|
|
||||||
|
|
||||||
// now return a custom-made instruction for this translation:
|
|
||||||
return func(svm *vm) error {
|
|
||||||
svm.pat = stringReplacer.Replace(svm.pat)
|
|
||||||
svm.ip++
|
|
||||||
return nil
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
@ -446,8 +446,6 @@ github.com/posener/complete/match
|
||||||
github.com/profitbricks/profitbricks-sdk-go
|
github.com/profitbricks/profitbricks-sdk-go
|
||||||
# github.com/renstrom/fuzzysearch v0.0.0-20160331204855-2d205ac6ec17
|
# github.com/renstrom/fuzzysearch v0.0.0-20160331204855-2d205ac6ec17
|
||||||
github.com/renstrom/fuzzysearch/fuzzy
|
github.com/renstrom/fuzzysearch/fuzzy
|
||||||
# github.com/rwtodd/Go.Sed v0.0.0-20170507045331-d6d5d585814e
|
|
||||||
github.com/rwtodd/Go.Sed/sed
|
|
||||||
# github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735
|
# github.com/ryanuber/go-glob v0.0.0-20170128012129-256dc444b735
|
||||||
github.com/ryanuber/go-glob
|
github.com/ryanuber/go-glob
|
||||||
# github.com/saintfish/chardet v0.0.0-20120816061221-3af4cd4741ca
|
# github.com/saintfish/chardet v0.0.0-20120816061221-3af4cd4741ca
|
||||||
|
|
|
||||||
|
|
@ -36,24 +36,6 @@ Here is a full list of the available functions for reference.
|
||||||
|
|
||||||
- `build_name` - The name of the build being run.
|
- `build_name` - The name of the build being run.
|
||||||
- `build_type` - The type of the builder being used currently.
|
- `build_type` - The type of the builder being used currently.
|
||||||
- `env` - Returns environment variables. See example in [using home
|
|
||||||
variable](/docs/templates/user-variables.html#using-home-variable)
|
|
||||||
- `isotime [FORMAT]` - UTC time, which can be
|
|
||||||
[formatted](https://golang.org/pkg/time/#example_Time_Format). See more
|
|
||||||
examples below in [the `isotime` format
|
|
||||||
reference](/docs/templates/engine.html#isotime-function-format-reference).
|
|
||||||
- `lower` - Lowercases the string.
|
|
||||||
- `pwd` - The working directory while executing Packer.
|
|
||||||
- `sed` - Use [a golang implementation of
|
|
||||||
sed](https://github.com/rwtodd/Go.Sed) to parse an input string.
|
|
||||||
- `split` - Split an input string using separator and return the requested
|
|
||||||
substring.
|
|
||||||
- `template_dir` - The directory to the template for the build.
|
|
||||||
- `timestamp` - The current Unix timestamp in UTC.
|
|
||||||
- `uuid` - Returns a random UUID.
|
|
||||||
- `upper` - Uppercases the string.
|
|
||||||
- `user` - Specifies a user variable.
|
|
||||||
- `packer_version` - Returns Packer version.
|
|
||||||
- `clean_resource_name` - Image names can only contain certain characters and
|
- `clean_resource_name` - Image names can only contain certain characters and
|
||||||
have a maximum length, eg 63 on GCE & 80 on Azure. `clean_resource_name`
|
have a maximum length, eg 63 on GCE & 80 on Azure. `clean_resource_name`
|
||||||
will convert upper cases to lower cases and replace illegal characters with
|
will convert upper cases to lower cases and replace illegal characters with
|
||||||
|
|
@ -75,6 +57,26 @@ Here is a full list of the available functions for reference.
|
||||||
clean_resource_name}}"` will cause your build to fail because the image
|
clean_resource_name}}"` will cause your build to fail because the image
|
||||||
name will start with a number, which is why in the above example we prepend
|
name will start with a number, which is why in the above example we prepend
|
||||||
the isotime with "mybuild".
|
the isotime with "mybuild".
|
||||||
|
- `env` - Returns environment variables. See example in [using home
|
||||||
|
variable](/docs/templates/user-variables.html#using-home-variable)
|
||||||
|
- `isotime [FORMAT]` - UTC time, which can be
|
||||||
|
[formatted](https://golang.org/pkg/time/#example_Time_Format). See more
|
||||||
|
examples below in [the `isotime` format
|
||||||
|
reference](/docs/templates/engine.html#isotime-function-format-reference).
|
||||||
|
- `lower` - Lowercases the string.
|
||||||
|
- `packer_version` - Returns Packer version.
|
||||||
|
- `pwd` - The working directory while executing Packer.
|
||||||
|
- `replace` - ( old, new string, n int, s ) Replace returns a copy of the
|
||||||
|
string s with the first n non-overlapping instances of old replaced by new.
|
||||||
|
- `replace_all` - ( old, new string, s ) ReplaceAll returns a copy of the
|
||||||
|
string s with all non-overlapping instances of old replaced by new.
|
||||||
|
- `split` - Split an input string using separator and return the requested
|
||||||
|
substring.
|
||||||
|
- `template_dir` - The directory to the template for the build.
|
||||||
|
- `timestamp` - The current Unix timestamp in UTC.
|
||||||
|
- `uuid` - Returns a random UUID.
|
||||||
|
- `upper` - Uppercases the string.
|
||||||
|
- `user` - Specifies a user variable.
|
||||||
|
|
||||||
#### Specific to Amazon builders:
|
#### Specific to Amazon builders:
|
||||||
|
|
||||||
|
|
@ -336,17 +338,13 @@ this case, on the `fixed-string` value):
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
# sed Function Format Reference
|
# replace Function Format Reference
|
||||||
|
|
||||||
See the library documentation
|
Here are some examples using the replace options:
|
||||||
<a href="https://github.com/rwtodd/Go.Sed" class="uri">https://github.com/rwtodd/Go.Sed</a>
|
|
||||||
for notes about the difference between this golang implementation of sed and
|
|
||||||
the regexes you may be used to. A very simple example of this functionality:
|
|
||||||
|
|
||||||
"provisioners": [
|
``` liquid
|
||||||
{
|
build_name = foo-bar-provider
|
||||||
"type": "shell-local",
|
|
||||||
"environment_vars": ["EXAMPLE={{ sed \"s/null/awesome/\" build_type}}"],
|
{{ replace_all "-" "/" build_name }} = foo/bar/provider
|
||||||
"inline": ["echo build_type is $EXAMPLE\n"]
|
{{ build_name | replace "-" "/" 1 }} = foo/bar-provider
|
||||||
}
|
```
|
||||||
]
|
|
||||||
Loading…
Reference in New Issue