func addSourceWrappedWithLineDirective(sketch *types.SketchFile) string { source := "#line 1 " + utils.QuoteCppString(sketch.Name) + "\n" source += sketch.Source source += "\n" return source }
func (s *SketchSourceMerger) Run(ctx *types.Context) error { sketch := ctx.Sketch lineOffset := 0 includeSection := "" if !sketchIncludesArduinoH(&sketch.MainFile) { includeSection += "#include <Arduino.h>\n" lineOffset++ } includeSection += "#line 1 " + utils.QuoteCppString(sketch.MainFile.Name) + "\n" lineOffset++ ctx.IncludeSection = includeSection source := includeSection source += addSourceWrappedWithLineDirective(&sketch.MainFile) lineOffset += 1 for _, file := range sketch.OtherSketchFiles { source += addSourceWrappedWithLineDirective(&file) } ctx.LineOffset = lineOffset ctx.Source = source return nil }
func TestQuoteCppString(t *testing.T) { cases := map[string]string{ `foo`: `"foo"`, `foo\bar`: `"foo\\bar"`, `foo "is" quoted and \\bar"" escaped\`: `"foo \"is\" quoted and \\\\bar\"\" escaped\\"`, // ASCII 0x20 - 0x7e, excluding ` ` !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_abcdefghijklmnopqrstuvwxyz{|}~`: `" !\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_abcdefghijklmnopqrstuvwxyz{|}~"`, } for input, expected := range cases { require.Equal(t, expected, utils.QuoteCppString(input)) } }
func TestPrototypesAdderSketchWithInlineFunction(t *testing.T) { DownloadCoresAndToolsAndLibraries(t) sketchLocation := filepath.Join("sketch_with_inline_function", "sketch.ino") quotedSketchLocation := utils.QuoteCppString(Abs(t, sketchLocation)) ctx := &types.Context{ HardwareFolders: []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware"}, ToolsFolders: []string{"downloaded_tools"}, BuiltInLibrariesFolders: []string{"downloaded_libraries"}, OtherLibrariesFolders: []string{"libraries"}, SketchLocation: sketchLocation, FQBN: "arduino:avr:leonardo", ArduinoAPIVersion: "10600", Verbose: true, } buildPath := SetupBuildPath(t, ctx) defer os.RemoveAll(buildPath) commands := []types.Command{ &builder.ContainerSetupHardwareToolsLibsSketchAndProps{}, &builder.ContainerMergeCopySketchFiles{}, &builder.ContainerFindIncludes{}, &builder.PrintUsedLibrariesIfVerbose{}, &builder.WarnAboutArchIncompatibleLibraries{}, &builder.ContainerAddPrototypes{}, } for _, command := range commands { err := command.Run(ctx) NoError(t, err) } require.Equal(t, "#include <Arduino.h>\n#line 1 "+quotedSketchLocation+"\n", ctx.IncludeSection) expected := "#line 1 " + quotedSketchLocation + "\nvoid setup();\n#line 2 " + quotedSketchLocation + "\nvoid loop();\n#line 4 " + quotedSketchLocation + "\nshort unsigned int testInt();\n#line 8 " + quotedSketchLocation + "\nstatic int8_t testInline();\n#line 12 " + quotedSketchLocation + "\n__attribute__((always_inline)) uint8_t testAttribute();\n#line 1 " + quotedSketchLocation + "\n" obtained := ctx.PrototypesSection // ctags based preprocessing removes "inline" but this is still OK // TODO: remove this exception when moving to a more powerful parser expected = strings.Replace(expected, "static inline int8_t testInline();", "static int8_t testInline();", -1) obtained = strings.Replace(obtained, "static inline int8_t testInline();", "static int8_t testInline();", -1) // ctags based preprocessing removes "__attribute__ ....." but this is still OK // TODO: remove this exception when moving to a more powerful parser expected = strings.Replace(expected, "__attribute__((always_inline)) uint8_t testAttribute();", "uint8_t testAttribute();", -1) obtained = strings.Replace(obtained, "__attribute__((always_inline)) uint8_t testAttribute();", "uint8_t testAttribute();", -1) require.Equal(t, expected, obtained) }
func composePrototypeSection(line int, prototypes []*types.Prototype) string { if len(prototypes) == 0 { return constants.EMPTY_STRING } str := joinPrototypes(prototypes) str += "\n#line " str += strconv.Itoa(line) str += " " + utils.QuoteCppString(prototypes[0].File) str += "\n" return str }
func joinPrototypes(prototypes []*types.Prototype) string { prototypesSlice := []string{} for _, proto := range prototypes { if signatureContainsaDefaultArg(proto) { continue } prototypesSlice = append(prototypesSlice, "#line "+strconv.Itoa(proto.Line)+" "+utils.QuoteCppString(proto.File)) prototypeParts := []string{} if proto.Modifiers != "" { prototypeParts = append(prototypeParts, proto.Modifiers) } prototypeParts = append(prototypeParts, proto.Prototype) prototypesSlice = append(prototypesSlice, strings.Join(prototypeParts, " ")) } return strings.Join(prototypesSlice, "\n") }
func TestPrototypesAdderSketchWithTypename(t *testing.T) { DownloadCoresAndToolsAndLibraries(t) sketchLocation := filepath.Join("sketch_with_typename", "sketch.ino") quotedSketchLocation := utils.QuoteCppString(Abs(t, sketchLocation)) ctx := &types.Context{ HardwareFolders: []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware"}, LibrariesFolders: []string{"libraries", "downloaded_libraries"}, ToolsFolders: []string{"downloaded_tools"}, SketchLocation: sketchLocation, FQBN: "arduino:avr:leonardo", ArduinoAPIVersion: "10600", Verbose: true, } buildPath := SetupBuildPath(t, ctx) defer os.RemoveAll(buildPath) commands := []types.Command{ &builder.ContainerSetupHardwareToolsLibsSketchAndProps{}, &builder.ContainerMergeCopySketchFiles{}, &builder.ContainerFindIncludes{}, &builder.PrintUsedLibrariesIfVerbose{}, &builder.WarnAboutArchIncompatibleLibraries{}, &builder.ContainerAddPrototypes{}, } for _, command := range commands { err := command.Run(ctx) NoError(t, err) } require.Equal(t, "#include <Arduino.h>\n#line 1 "+quotedSketchLocation+"\n", ctx.IncludeSection) expected := "#line 6 " + quotedSketchLocation + "\nvoid setup();\n#line 10 " + quotedSketchLocation + "\nvoid loop();\n#line 12 " + quotedSketchLocation + "\ntypename Foo<char>::Bar func();\n#line 6 " + quotedSketchLocation + "\n" obtained := ctx.PrototypesSection // ctags based preprocessing ignores line with typename // TODO: remove this exception when moving to a more powerful parser expected = strings.Replace(expected, "#line 12 "+quotedSketchLocation+"\ntypename Foo<char>::Bar func();\n", "", -1) obtained = strings.Replace(obtained, "#line 12 "+quotedSketchLocation+"\ntypename Foo<char>::Bar func();\n", "", -1) require.Equal(t, expected, obtained) }
func TestPrototypesAdderSketchWithIfDef2SAM(t *testing.T) { DownloadCoresAndToolsAndLibraries(t) sketchLocation := filepath.Join("sketch_with_ifdef", "sketch.ino") quotedSketchLocation := utils.QuoteCppString(Abs(t, sketchLocation)) ctx := &types.Context{ HardwareFolders: []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware"}, ToolsFolders: []string{"downloaded_tools"}, BuiltInLibrariesFolders: []string{"downloaded_libraries"}, OtherLibrariesFolders: []string{"libraries"}, SketchLocation: sketchLocation, FQBN: "arduino:sam:arduino_due_x_dbg", ArduinoAPIVersion: "10600", Verbose: true, } buildPath := SetupBuildPath(t, ctx) defer os.RemoveAll(buildPath) commands := []types.Command{ &builder.ContainerSetupHardwareToolsLibsSketchAndProps{}, &builder.ContainerMergeCopySketchFiles{}, &builder.ContainerFindIncludes{}, &builder.PrintUsedLibrariesIfVerbose{}, &builder.WarnAboutArchIncompatibleLibraries{}, &builder.ContainerAddPrototypes{}, } for _, command := range commands { err := command.Run(ctx) NoError(t, err) } require.Equal(t, "#include <Arduino.h>\n#line 1 "+quotedSketchLocation+"\n", ctx.IncludeSection) require.Equal(t, "#line 2 "+quotedSketchLocation+"\nvoid ifBranch();\n#line 9 "+quotedSketchLocation+"\nvoid f1();\n#line 10 "+quotedSketchLocation+"\nvoid f2();\n#line 12 "+quotedSketchLocation+"\nvoid setup();\n#line 14 "+quotedSketchLocation+"\nvoid loop();\n#line 2 "+quotedSketchLocation+"\n", ctx.PrototypesSection) expectedSource := LoadAndInterpolate(t, filepath.Join("sketch_with_ifdef", "sketch.preprocessed.SAM.txt"), ctx) require.Equal(t, expectedSource, strings.Replace(ctx.Source, "\r\n", "\n", -1)) }
func TestPrototypesAdderBridgeExample(t *testing.T) { DownloadCoresAndToolsAndLibraries(t) sketchLocation := filepath.Join("downloaded_libraries", "Bridge", "examples", "Bridge", "Bridge.ino") quotedSketchLocation := utils.QuoteCppString(Abs(t, sketchLocation)) ctx := &types.Context{ HardwareFolders: []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware"}, ToolsFolders: []string{"downloaded_tools"}, BuiltInLibrariesFolders: []string{"downloaded_libraries"}, OtherLibrariesFolders: []string{"libraries"}, SketchLocation: sketchLocation, FQBN: "arduino:avr:leonardo", ArduinoAPIVersion: "10600", Verbose: true, } buildPath := SetupBuildPath(t, ctx) defer os.RemoveAll(buildPath) ctx.DebugLevel = 10 commands := []types.Command{ &builder.ContainerSetupHardwareToolsLibsSketchAndProps{}, &builder.ContainerMergeCopySketchFiles{}, &builder.ContainerFindIncludes{}, &builder.PrintUsedLibrariesIfVerbose{}, &builder.WarnAboutArchIncompatibleLibraries{}, &builder.ContainerAddPrototypes{}, } for _, command := range commands { err := command.Run(ctx) NoError(t, err) } require.Equal(t, "#include <Arduino.h>\n#line 1 "+quotedSketchLocation+"\n", ctx.IncludeSection) require.Equal(t, "#line 33 "+quotedSketchLocation+"\nvoid setup();\n#line 46 "+quotedSketchLocation+"\nvoid loop();\n#line 62 "+quotedSketchLocation+"\nvoid process(BridgeClient client);\n#line 82 "+quotedSketchLocation+"\nvoid digitalCommand(BridgeClient client);\n#line 109 "+quotedSketchLocation+"\nvoid analogCommand(BridgeClient client);\n#line 149 "+quotedSketchLocation+"\nvoid modeCommand(BridgeClient client);\n#line 33 "+quotedSketchLocation+"\n", ctx.PrototypesSection) }
func TestPrototypesAdderSketchWithConst(t *testing.T) { DownloadCoresAndToolsAndLibraries(t) sketchLocation := filepath.Join("sketch_with_const", "sketch.ino") quotedSketchLocation := utils.QuoteCppString(Abs(t, sketchLocation)) ctx := &types.Context{ HardwareFolders: []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware"}, ToolsFolders: []string{"downloaded_tools"}, BuiltInLibrariesFolders: []string{"downloaded_libraries"}, OtherLibrariesFolders: []string{"libraries"}, SketchLocation: sketchLocation, FQBN: "arduino:avr:uno", ArduinoAPIVersion: "10600", Verbose: true, } buildPath := SetupBuildPath(t, ctx) defer os.RemoveAll(buildPath) commands := []types.Command{ &builder.ContainerSetupHardwareToolsLibsSketchAndProps{}, &builder.ContainerMergeCopySketchFiles{}, &builder.ContainerFindIncludes{}, &builder.PrintUsedLibrariesIfVerbose{}, &builder.WarnAboutArchIncompatibleLibraries{}, &builder.ContainerAddPrototypes{}, } for _, command := range commands { err := command.Run(ctx) NoError(t, err) } require.Equal(t, "#include <Arduino.h>\n#line 1 "+quotedSketchLocation+"\n", ctx.IncludeSection) require.Equal(t, "#line 1 "+quotedSketchLocation+"\nvoid setup();\n#line 2 "+quotedSketchLocation+"\nvoid loop();\n#line 4 "+quotedSketchLocation+"\nconst __FlashStringHelper* test();\n#line 6 "+quotedSketchLocation+"\nconst int test3();\n#line 8 "+quotedSketchLocation+"\nvolatile __FlashStringHelper* test2();\n#line 10 "+quotedSketchLocation+"\nvolatile int test4();\n#line 1 "+quotedSketchLocation+"\n", ctx.PrototypesSection) }
func TestPrototypesAdderSketchNoFunctionsTwoFiles(t *testing.T) { DownloadCoresAndToolsAndLibraries(t) sketchLocation := filepath.Join("sketch_no_functions_two_files", "main.ino") quotedSketchLocation := utils.QuoteCppString(Abs(t, sketchLocation)) ctx := &types.Context{ HardwareFolders: []string{filepath.Join("..", "hardware"), "hardware", "downloaded_hardware"}, ToolsFolders: []string{"downloaded_tools"}, BuiltInLibrariesFolders: []string{"downloaded_libraries"}, OtherLibrariesFolders: []string{"libraries"}, SketchLocation: filepath.Join("sketch_no_functions_two_files", "main.ino"), FQBN: "arduino:avr:leonardo", ArduinoAPIVersion: "10600", Verbose: true, } buildPath := SetupBuildPath(t, ctx) defer os.RemoveAll(buildPath) commands := []types.Command{ &builder.ContainerSetupHardwareToolsLibsSketchAndProps{}, &builder.ContainerMergeCopySketchFiles{}, &builder.ContainerFindIncludes{}, &builder.PrintUsedLibrariesIfVerbose{}, &builder.WarnAboutArchIncompatibleLibraries{}, &builder.ContainerAddPrototypes{}, } for _, command := range commands { err := command.Run(ctx) NoError(t, err) } require.Equal(t, "#include <Arduino.h>\n#line 1 "+quotedSketchLocation+"\n", ctx.IncludeSection) require.Equal(t, "", ctx.PrototypesSection) }