Skip to content

Commit

Permalink
lang: core: strings: Add a substring function named substr
Browse files Browse the repository at this point in the history
  • Loading branch information
purpleidea committed Oct 3, 2024
1 parent 74119a0 commit 898b58e
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
9 changes: 9 additions & 0 deletions examples/lang/substr.mcl
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import "fmt"
import "strings"

$s = "hello"
$sub = strings.substr($s, 0, 4)

print "debug" {
msg => "${sub}",
}
61 changes: 61 additions & 0 deletions lang/core/strings/substring_func.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
// Mgmt
// Copyright (C) 2013-2024+ James Shubin and the project contributors
// Written by James Shubin <[email protected]> and the project contributors
//
// 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 <https://www.gnu.org/licenses/>.
//
// Additional permission under GNU GPL version 3 section 7
//
// If you modify this program, or any covered work, by linking or combining it
// with embedded mcl code and modules (and that the embedded mcl code and
// modules which link with this program, contain a copy of their source code in
// the authoritative form) containing parts covered by the terms of any other
// license, the licensors of this program grant you additional permission to
// convey the resulting work. Furthermore, the licensors of this program grant
// the original author, James Shubin, additional permission to update this
// additional permission if he deems it necessary to achieve the goals of this
// additional permission.

package corestrings

import (
"context"
"fmt"

"github.com/purpleidea/mgmt/lang/funcs/simple"
"github.com/purpleidea/mgmt/lang/types"
)

func init() {
simple.ModuleRegister(ModuleName, "substr", &simple.Scaffold{
T: types.NewType("func(s str, low int, high int) str"),
F: SubStr,
})
}

// SubStr returns a substring of the input string from low to high.
func SubStr(ctx context.Context, input []types.Value) (types.Value, error) {
s := input[0].Str()
low := int(input[1].Int())
high := int(input[2].Int())
if low < 0 || low > len(s) {
return nil, fmt.Errorf("low/high out of range")
}
if high < 0 || high > len(s) || low > high {
return nil, fmt.Errorf("low/high out of range")
}
return &types.StrValue{
V: s[low:high],
}, nil
}

0 comments on commit 898b58e

Please sign in to comment.