fix mavlink codegen enum methods #47

sirno-baka · 2023-03-27T14:56:22Z

Bug while calling the MarshalText method for enum
Example:
(common.MAV_SYS_STATUS_SENSOR_3D_GYRO | common.MAV_SYS_STATUS_SENSOR_3D_ACCEL).MarshalText()

an error occurs because this value is not in labels_{{ENUM}}

I propose to return the hex value of the number.

aler9 · 2023-03-28T14:59:23Z

Hello, you're right about adding support for combined flags, however, TextUnmarshal() has been specifically requested by some users in order to convert strings into enums, and this PR breaks the feature.

Therefore, edit the PR in this way:

in MarshalText, return the hex dump if and only if there isn't an associated label:

func (e enum) MarshalText() ([]byte, error) {
    if l, ok := labels_{{ .Enum.Name }}[e]; ok {
        return []byte(l), nil
    }
    return []byte(strconv.FormatUint(uint64(e), 16)), nil
}

in UnmarshalText do the same:

func (e enum) UnmarshalText(text []byte) error {
	if rl, ok := reverseLabels_{{ .Enum.Name }}[string(text)]; ok {
		*e = rl
		return nil
	}
	hexInt, err := strconv.ParseUint(string(text), 16, 32)
	if err == nil {
		*e = {{ .Enum.Name }}(hexInt)
		return nil
	}
	return errors.New("invalid value")
}

Link String() to MarshalText() in order for them to have the same behavior:

func (e {{ .Enum.Name }}) String() string {
    val, _ := e.MarshalText()
   return string(val)
}

thanks

sirno-baka · 2023-03-29T09:04:08Z

specifically requested by some users in order to convert strings into enums

If you need names, I can suggest this code:

type MAV_SYS_STATUS_SENSOR uint32

const (
	MAV_SYS_STATUS_SENSOR_3D_GYRO  MAV_SYS_STATUS_SENSOR = 1 << 0 // 0x01
	MAV_SYS_STATUS_SENSOR_3D_ACCEL MAV_SYS_STATUS_SENSOR = 1 << 1 // 0x02
)

var labels_MAV_SYS_STATUS_SENSOR = map[MAV_SYS_STATUS_SENSOR]string{
	MAV_SYS_STATUS_SENSOR_3D_GYRO:  "MAV_SYS_STATUS_SENSOR_3D_GYRO",
	MAV_SYS_STATUS_SENSOR_3D_ACCEL: "MAV_SYS_STATUS_SENSOR_3D_ACCEL",
}

func (e MAV_SYS_STATUS_SENSOR) MarshalText() ([]byte, error) {
	var names []string
	for mask, label := range labels_MAV_SYS_STATUS_SENSOR {
		if e&mask == mask {
			names = append(names, label)
		}
	}
	return []byte(strings.Join(names, " | ")), nil
}

func (e *MAV_SYS_STATUS_SENSOR) UnmarshalText(text []byte) error {
	labels := strings.Split(string(text), " | ")
	var mask MAV_SYS_STATUS_SENSOR
	for _, label := range labels {
		found := false
		for value, l := range labels_MAV_SYS_STATUS_SENSOR {
			if l == label {
				mask |= value
				found = true
				break
			}
		}
		if !found {
			return fmt.Errorf("invalid label '%s'", label)
		}
	}
	*e = mask
	return nil
}

func (e MAV_SYS_STATUS_SENSOR) String() string {
	val, _ := e.MarshalText()
	return string(val)
}

Tests:

value := MAV_SYS_STATUS_SENSOR_3D_GYRO | MAV_SYS_STATUS_SENSOR_3D_ACCEL
byteMarshal, _ := value.MarshalText()
fmt.Println(string(byteMarshal)) // "MAV_SYS_STATUS_SENSOR_3D_GYRO | MAV_SYS_STATUS_SENSOR_3D_ACCEL"  <nil>

value = MAV_SYS_STATUS_SENSOR_3D_GYRO
fmt.Println(value.String()) // "MAV_SYS_STATUS_SENSOR_3D_GYRO"

var sens MAV_SYS_STATUS_SENSOR
err := sens.UnmarshalText([]byte("MAV_SYS_STATUS_SENSOR_3D_GYRO | MAV_SYS_STATUS_SENSOR_3D_ACCEL"))
if err != nil {
// handle error
}
fmt.Println(sens.String()) // "MAV_SYS_STATUS_SENSOR_3D_GYRO | MAV_SYS_STATUS_SENSOR_3D_ACCEL"

sirno-baka · 2023-03-30T10:58:09Z

It seems that with the update of mavlink, new Enums and Messages have been added.
mavlink/mavlink#1943
and i forgot to add them to the commit

Refactored MarshalText, UnmarshalText, and String methods for Enum types. Add MessageTargetAbsolute MessageTargetRelative and TARGET_OBS_FRAME TARGET_ABSOLUTE_SENSOR_CAPABILITY_FLAGS Enums

aler9 · 2023-03-31T10:16:21Z

merged, thanks!

willschenck · 2023-08-24T13:28:16Z

pkg/dialects/common/enum_adsb_emitter_type.go

@@ -57,27 +58,38 @@ var labels_ADSB_EMITTER_TYPE = map[ADSB_EMITTER_TYPE]string{

 // MarshalText implements the encoding.TextMarshaler interface.
 func (e ADSB_EMITTER_TYPE) MarshalText() ([]byte, error) {
-	if l, ok := labels_ADSB_EMITTER_TYPE[e]; ok {
-		return []byte(l), nil
+	var names []string


Why was this changed? This enum is not a bit mask, so these changes to the MarshalText and UnmashalText methods return all the types whose values match the mask, not the single expected string.
For example, I would expect this test to pass:

assert.Equal(t, "ADSB_EMITTER_TYPE_ROTOCRAFT", common.ADSB_EMITTER_TYPE_ROTOCRAFT.String())

But it fails:

-ADSB_EMITTER_TYPE_ROTOCRAFT +ADSB_EMITTER_TYPE_ROTOCRAFT | ADSB_EMITTER_TYPE_SMALL | ADSB_EMITTER_TYPE_HIGH_VORTEX_LARGE | ADSB_EMITTER_TYPE_HEAVY | ADSB_EMITTER_TYPE_LARGE | ADSB_EMITTER_TYPE_LIGHT | ADSB_EMITTER_TYPE_HIGHLY_MANUV | ADSB_EMITTER_TYPE_NO_INFO

aler9 force-pushed the fix-mav-codegen branch 3 times, most recently from a9368f6 to 7c2112e Compare March 31, 2023 10:11

fix mavlink codegen enum methods

3976fb9

Refactored MarshalText, UnmarshalText, and String methods for Enum types. Add MessageTargetAbsolute MessageTargetRelative and TARGET_OBS_FRAME TARGET_ABSOLUTE_SENSOR_CAPABILITY_FLAGS Enums

aler9 force-pushed the fix-mav-codegen branch from 7c2112e to 3976fb9 Compare March 31, 2023 10:13

aler9 merged commit 1e50535 into bluenviron:main Mar 31, 2023

aler9 mentioned this pull request Mar 31, 2023

bug in enum MarshalText() methods #46

Closed

willschenck reviewed Aug 24, 2023

View reviewed changes

github-actions bot locked and limited conversation to collaborators Feb 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix mavlink codegen enum methods #47

fix mavlink codegen enum methods #47

sirno-baka commented Mar 27, 2023

aler9 commented Mar 28, 2023

sirno-baka commented Mar 29, 2023 •

edited

Loading

sirno-baka commented Mar 30, 2023 •

edited

Loading

aler9 commented Mar 31, 2023

willschenck Aug 24, 2023 •

edited

Loading

fix mavlink codegen enum methods #47

fix mavlink codegen enum methods #47

Conversation

sirno-baka commented Mar 27, 2023

aler9 commented Mar 28, 2023

sirno-baka commented Mar 29, 2023 • edited Loading

sirno-baka commented Mar 30, 2023 • edited Loading

aler9 commented Mar 31, 2023

willschenck Aug 24, 2023 • edited Loading

Choose a reason for hiding this comment

sirno-baka commented Mar 29, 2023 •

edited

Loading

sirno-baka commented Mar 30, 2023 •

edited

Loading

willschenck Aug 24, 2023 •

edited

Loading