haikuarchives / paladin Goto Github PK

Paladin is an open source integrated development environment (IDE) for Haiku OS

License: MIT License

C++ 90.71% C 5.79% Shell 0.44% Lua 0.98% Makefile 0.92% HTML 1.16%

paladin's Introduction

Paladin

Paladin is an open source integrated development environment (IDE) modeled after BeOS' BeIDE. It can use fastdep and ccache to speed up builds if you have them installed.

To build: run pkgman install devel:libpcre unittest++_devel and then run ./buildsuite.sh 1

Features

Command-line build support
Quick Find a file by name with Alt+F, with abbreviations (E.g. QFW finds QuickFindWindow.cpp)
Multithreaded builds
Revision control-friendly project files
More run options for projects
Explicit support for debugging with gdb under Haiku
Bundled helper tools
Streamlined project settings
Out-of-the-box support for Lex and Yacc
Support for text and binary resource files
Projects can include notes and other files that aren't source code
Project templates
Out-of-the-box makefile generation
Integrated source code management
1-click project backups

Starting a Project

Install Paladin from HaikuDepot.
Open Paladin.
Select Create New Project.

Select Project Type from the dropdown menu, give your project a name, a file name and save destination and click Create Project.

Select the file you want to code in.

Here's how an editor window looks like:

(Code excerpt from HexVexed)

Press Alt+R to compile and run your program.

Some Very Useful Features

Dealing with Errors

While warnings will not stop Paladin from continuing to build a project, if an error occurs, Paladin will stop the build so that the errors can be corrected. Errors are listed in pink; warnings are listed in yellow. Double-clicking on an error or warning will open up the file containing it in the editor. The Copy to Clipboard button will copy all visible errors and/or warnings to the system clipboard for pasting into other documents.

Backing Up Projects

Your project can be quickly placed into a compressed archive in a folder of your choosing with your project's name and timestamp for the backup with just a click of this menu item.

Helper Tools

Developers seem to need a wide variety of tools when writing code. Paladin includes a few small accessories to complement the main development environment. An ASCII table, Regular expression tester, Symbol finder and a tool to easily choose a license for your project can be accessed from the Tools menu.

License

MIT

paladin's People

Contributors

Stargazers

Watchers

paladin's Issues

Add LocaleKit support

Paths are full instead of being relative

As in title.

Show File SCM status in Project List

New, Edited, etc.

Create intro Documentation for key features

Something to get people jazzed to use it. Build on what's in the README.md file.

documentation/*.md files perhaps with screenshots so as not to clutter the root folder.

Link Test output to source of problem

Not the point where the test failed (as that's in the test!), but in the place slightly higher in the stack.

Add command-line option to export as a Makefile

Add a command-line option to allow opening a Paladin .pld or BeIDE .proj file and export a Makefile

Switch branches by clicking on SCM branch

Also refresh full ProjectList, open files, etc.

Show SCM branch status in the status bar

App.h not added as dependency to App.cpp when creating new project

Created a new Be application project. Added MainWindow.h as a dependency to App.cpp, but didn't add App.h.

Remove R1a4 support

New directory constants (discussed in b9e8090 and 7d62073)
Makefile generation

Selecting New Group results in renaming group

Right clicking the 'Source files' group show New Group, Rename Group, and Sort Group. If you select New Group, it actually displays the rename group dialog.

Rename group and sort group work as expected.

hrev52346
x86_64
Paladin built from latest master source

Consider an option to show relative paths rather than file names

In complex projects there are multiple source folders. Might be nice to have an option so in the file list the relative path within the project is shown for the item rather than just the file name.

As an extension, would be nice to also have the option of relative path sub folder between the group folder and the source file item.

Consider adding progress bar for long running process(es)

Builds, global search and replace, set licenses - all take time.

Consider adding a progress bar to the status bar, with perhaps a clickable 'full details' button that opens a detailed panel showing all concurrently running processes.

Ensure dependency files are updated in the UI

Double check in the code that dependencies are updated in the new dependency list when:-

New source files (and header files) are created
Existing files are added to the project
The Project -> Update Dependencies option is selected
Files are removed from the project
After a build
Whenever the project is saved/updated by Paladin

Project Add New Files doesn't work

In the Paladin.pld project, try to add PaladinFileFilter.cpp to the Source files group. You can select and click ok, but the file isn't added or written to the pld file.

ProjectWindow doesn't remember previous dimensions

Save the main Project Window dimensions/position so it appears correctly the next time it is opened.

Add common test file templates

E.g. 'CppUnit test' template

Git GetCheckinHeader is totally broken

Paladin/SourceControl/GitSourceControl.cpp#L320

Question: UX issues in how Paladin works with Pe

Not sure how people wanted to address the below, so thought I'd put a question in GitHub about them.

Quitting Paladin should quit child Pe windows

If you're editing a project with many windows of code open, it would be nice for all the Pe windows that were opened by Paladin to be closed by Paladin. Not sure how feasible this is with the current way of launching them though.

Pe windows created by Paladin should be stacked

A nice feature of Koder is that all newly opened code windows are stacked rather than independent. Would be good to do this also. (Also, unlike Koder, the file paths should be relative to the project root, not absolute paths, in order to save screen real estate)

Pe editing options are file based, not project based

Most projects use a consistent set of editing settings. E.g. tabs at 4 spaces width. Pe's preferences for this are file based or global (to the user) - not project based. Again, not sure if this can be resolved give Pe is an external app.

Cross file code references

Pe has the f(x) button which can skip to a named function within a file. It would be good to expand upon this functionality so that hitting a key shortcut looks up the function/class under the cursor, whether in the same file or another one. Again, as Pe is a single file editor it won't know how to resolve a project's references, so not sure how feasible this is.

Pe's .h button doesn't work

Pe successfully lists the correct header files in the .h toolbar button drop down, but clicking on them does nothing. Doesn't open them. Leads to a little confusion for the user.

In Summary

Given the above, is it best to stick with Pe, or should the option be considered of having a Paladin managed editor window? Whether that is an embedded Pe frame, or Koder's approach. I'm not sure what is technically possible integration wise with Pe as a separate external app.

Status bar issues

** Misalignment **
See the below image. Slight misalignment with the status bar.

** Status bar area not used **
Should probably write out the status here at some point. E.g. last saved/opened/new file added, built OK, etc.

Update screenshot for Project Window on README page

Shows source files, but not the new dependency files functionality.

DEPENDENCY line includes the source file that the dependency is for

E.g. for Paladin.pld:-

SOURCEFILE=SourceControl/SVNSourceControl.cpp
DEPENDENCY=SourceControl/SVNSourceControl.cpp|SourceControl/SVNSourceControl.h|SourceControl/SourceControl.h|ThirdParty/DPath.h

I think this is more of a bug than a feature. Rather superfluous to add this as a dependency I would have thought?

Review command line options and test

As for UI, but on command line. Log issues as found.

Question: Do you want contributors to add personal copyright statements, or not?

Happy to copyright to myself, or Haiku Project, or whatever. Do let me know.

Use current Makefile template

Use latest Makefile template (## Haiku Generic Makefile v2.6 ##) found in /boot/system/develop/etc/

List header files

Currently the list of files in a project doesn't list the header files just the .cpp (and other files). It would be useful if it could list the header files too.

Consider multiple mechanisms for builds

Trying to build Paladin fails - it uses the build sh file to set up make, so we need an option to run this.

Support potentially:-

Makefile
Jamfile
Bash script

Also support choices for 'error detection'. E.g. gcc errors, bash failures, etc. - then display these in the errors and warnings pane.

Create both header and source file tickbox doesn't add DEPENDENCY line to project

When going to Project > Add new source file you can tick the box 'add new header and source file'.
Ticking this does indeed add both a header and source file, but it only adds the source file to the project - it doesn't not add the header file to a DEPENDENCY line in the project file.

New Projects from templates are read only

I think this is because they're copied from a templates folder. We need to ensure that u+w is set on all new project files and folders.

Stop Paladin Project Window appearing 2 pixels off screen

When the ProjectWindow opens it appears 2 pixels above and 2 pixels to the left of the top left corner of the screen.

Remove externals from the tree

Specifically, fastdep and ccache.

UX: Ease of launching tools

Give a shortcut key codes for all tools.

Consider a quick show/hide toolbar toggles for the tools, perhaps just above the Project Window status bar.

Consider adding a Locales list item group for Locale editing

Could introspect LOCALE in the Makefile, or check for the presence of <Locale.h> in source files, to determine if Locales are supported.

On double clicking a Locale, instead of loading Pe we could launch CatKeysEditor or similar.

As an extension, if make is called, also call make bindcatalogs immediately after.

Error Window's title bar appears entirely off screen

When you run a build or run the binary, an error window pops up with an issue. This window appears such that it's entire title bar area appears off screen, necessitating Strl+Alt+Click-dragging to get on to the screen.

Also set the windows proportions more sensibly (to be much wider)

Add support for issuing a GitHub pull request

Will require GitHub login Window

Will require setting local github author info (E.g. email, username (GitHub), username (local)) in ~/.git

Also allow 'view PR in GitHub' after creation

Add Build Tests function

May require settings too

Add run tests function

May require menu item/popup window

Settings: Compiler choice and header paths

Commenting for clarification.
When creating a makefile with Paladin
SYSTEM_INCLUDE_PATHS = /boot/system/develop/headers/cpp
However, this is a BeOS path. Depending on whether gcc2 or gcc5 is being used, the Haiku path is:
gcc2 - /boot/system/develop/headers/c++/2.95.3
gcc5 - /boot/system/develop/tools/x86/lib/gcc/i586-pc-haiku/5.4.0/include/c++

Update revision, version info

As major and minor issues are resolved in Paladin, we should consider when/if to do major and minor point releases. The appropriate files will need to get updated to reflect this versioning info and then a matching tagged release can be made. We should verify Paladin's stability at each release prior to tagging.

Nonexistent libraries aren't kept

Open a project that has libraries that are not on the system
Select "Keep" when asked.
Close Paladin.

The file does not contain the nonexistent libraries anymore...

Add SCM Checkin and Push capability links to SCM status bar

E.g. popup

Diagnose debug message from Project Settings

Open project settings from the menu bar. Don't edit anything. Close project settings. See this in the terminal output (Running Paladin -d -v):-

Range: 86.000000 - 1.000000
Range: 86.000000 - 358.000000
Unlocking BLocker with sem 71685488 from wrong thread 58951, current holder 58545 (see issue #6400).

Rename group popup ellipsis issue

Supposed to have %ellipsis% - missing trailing % sign. See image below.

Drop Licenses directory and pull them from system/data/licenses instead

Rather than keeping the license text for the various open source license types in duplicate locations, Paladin should be updated to pull the license text from the system/data/licenses directory that comes with Haiku by default. This will likely require some code changes, so don't drop the licenses dir until the code is fixed.

Errors window fails to open

Clicking on the Tools -> Error Window... menu results in no window appearing, but a small icon does appear in the Deskbar. Clicking on that icon results in nothing appearing.

I'll attempt to find the root cause in the code

version 1.4 d1 hrev52346

Open Project allows selecting of an App executable not just pld, causing App Window to close

Installed the devel libraries and built as per instructions. Launching the built Paladin works, but trying to open the Paladin/Paladin/Paladin project file results in my last loaded app being shown in the project explorer, not the Paladin code project.

Trying to import that project too does nothing in the import screen.

No error messages, and no explanation. Nothing on the command line when running Paladin -d -v.

I'm not sure at this point whether this is a bug in the code or user error - I have no feedback to determine this.

Investigate how developers write tests for Haiku classes

Questions:-

Which testing frameworks are used (Cppunit et al)
Are there common test classes that can be templated?
How are tests integrated in to Makefile builds? Separately make target? Separate script?
What output is generated, and how do people act upon it?