Difference between revisions of "Install and use Monodevelop"

From LSDevLinux
Jump to: navigation, search
m (Ubuntu 12.04 Precise: fix tmpdir syntax)
m (Ubuntu 12.04 Precise: fixup pre-sudo usage)
Line 25: Line 25:
 
chmod +x "$MONODEVELOP_LAUNCHER"</nowiki>
 
chmod +x "$MONODEVELOP_LAUNCHER"</nowiki>
 
<li>Install mono wrapper script that causes FieldWorks environment to be set up when running from Monodevelop:</li>
 
<li>Install mono wrapper script that causes FieldWorks environment to be set up when running from Monodevelop:</li>
  <nowiki>sudo echo have sudo
+
  <nowiki>sudo echo have sudo</nowiki>
cd $(mktemp -d)
+
 
 +
<nowiki>cd $(mktemp -d)
 
wget http://linux.lsdev.sil.org/downloads/fieldworks-dev/mono-fw
 
wget http://linux.lsdev.sil.org/downloads/fieldworks-dev/mono-fw
 
sudo cp mono-fw /usr/local/bin
 
sudo cp mono-fw /usr/local/bin

Revision as of 12:47, 19 November 2013

Instructions to install and use Monodevelop (http://monodevelop.com/) to edit FieldWorks code.

Install

Ubuntu 12.04 Precise

  1. Install Monodevelop:
  2. sudo add-apt-repository ppa:ermshiperete/monodevelop
    
    sudo apt-get update
    sudo apt-get install monodevelop-current
    
  3. Create Monodevelop launcher:
  4. MONODEVELOP_LAUNCHER="$HOME/Desktop/monodevelop.desktop"
    [ -e "$MONODEVELOP_LAUNCHER" ] && MONODEVELOP_LAUNCHER="$(mktemp $HOME/Desktop/monodevelop-XXXX.desktop)"
    cat > "$MONODEVELOP_LAUNCHER" <<ENDOFLAUNCHER
    #!/usr/bin/env xdg-open
    
    [Desktop Entry]
    Version=1.0
    Type=Application
    Terminal=false
    Exec=bash -c 'export FIELDWORKS_ENVIRON="\$HOME/fwrepo/fw/environ"; /opt/monodevelop/bin/monodevelop-launcher.sh'
    Name=Monodevelop FW
    Icon=/opt/monodevelop/share/icons/hicolor/scalable/apps/monodevelop.svg
    ENDOFLAUNCHER
    chmod +x "$MONODEVELOP_LAUNCHER"
    
  5. Install mono wrapper script that causes FieldWorks environment to be set up when running from Monodevelop:
  6. sudo echo have sudo
    
    cd $(mktemp -d)
    wget http://linux.lsdev.sil.org/downloads/fieldworks-dev/mono-fw
    sudo cp mono-fw /usr/local/bin
    sudo chmod +x /usr/local/bin/mono-fw
    TRASH=$(mktemp --tmpdir mono-real-trashed-XXXXX)
    echo If present, existing /usr/local/bin/mono-real file being preserved as $TRASH
    sudo mv /usr/local/bin/mono-real $TRASH || true
    sudo cp -a /usr/local/bin/mono{,-real}
    sudo cp -a /usr/local/bin/mono-fw /usr/local/bin/mono
    

Configure

Monodevelop can be configured to use a different .NET runtime by doing the following:

  1. Launch monodevelop
  2. Choose Edit > Preferences.
  3. Under Preferences, click .NET Runtimes.
  4. Click a runtime (eg Mono 2.10.4 (/usr/local)) and click Set as Default.
  5. Click OK.

Troubleshooting

Specified Default Runtime not being used

If running Ubuntu 10.10 Maverick and MonoDevelop 2.8, and running FieldWorks from terminal works but running from MonoDevelop shows a FieldWorks yellow crash dialog box with a message "Msg: Method not found: 'System.Windows.Forms.Control.IgnoreUpdates'", it may be that MonoDevelop (running using a mono in /opt/mono) is using the Mono GAC in /opt/mono rather than the Mono GAC and libraries in /usr/local/mono, even if /usr/local/mono is selected as the Default Runtime.

Seen in the Application Autput window in monodevelop: Loaded assembly: /opt/mono-2.10/lib/mono/gac/System.Windows.Forms/2.0.0.0__b77a5c561934e089/System.Windows.Forms.dll

Set MONO_GAC_PREFIX to /usr/local/lib/mono in the Project/Options/Run/General Environment Variables. This appears to fix the problem.

Use Monodevelop with FieldWorks

Editing code

There is not a global solution file. To edit code in a project, open the csproj project file in monodevelop.

Integrating with VCS

While Monodevelop 2.2.1 successfully uses and edits .csproj files, it seems to delete a few things as well that Visual Studio may find useful. When committing .csproj files with meaningful changes, consider not committing unnecessary <Reference> reordering or the deletions of sections such as:

-    <ApplicationIcon>
-    </ApplicationIcon>
-    <AssemblyOriginatorKeyFile>
-    </AssemblyOriginatorKeyFile>

-    <StartupObject>
-    </StartupObject>

-    <AllowUnsafeBlocks>false</AllowUnsafeBlocks>
-    <CheckForOverflowUnderflow>false</CheckForOverflowUnderflow>

-    <NoStdLib>false</NoStdLib>
-    <NoWarn>
-    </NoWarn>

-    <TreatWarningsAsErrors>false</TreatWarningsAsErrors>

-    <DebugSymbols>false</DebugSymbols>

If monodevelop makes undesired modifications to all of your open csproj files, you can revert all .csproj file changes by running a command such as

fwrepo/fw/Src$ find -name \*csproj -print0 | xargs -0 git checkout

Building

Building projects works from within monodevelop.

You can also build from terminal using nant (see Build_FieldWorks#Subsequent_builds_should_be_built_by_doing:).

If building in monodevelop says something like

Build failed. Access to the path ".../fwrepo/fw/Lib/debug/ECInterfaces.dll" or ".../fwrepo/fw/Output/Debug/ECInterfaces.dll" is denied.

then do

Output/Debug$ chmod u+w *

and build again.

Debugging

Debugging C# and C++ code works in monodevelop. Sometimes when you debug a GUI program and reach a breakpoint, monodevelop might freeze. To avoid this, you can have the program run inside a Xephyr window. To do this, start Xephyr:

$ Xephyr :2 -screen 1024x768 &
$ DISPLAY=:2 metacity &

And in monodevelop, right-click the startup project, and click Options. Under Run, click General. In the Environment Variables section, add a Variable "DISPLAY" and a Value ":2". Now when you Run or Debug this project, it will display the program in your Xephyr window. Remember not to check in this setting of DISPLAY in the csproj.


Currently (20100412), the debugger in MonoDevelop 2.2.1 does not work with the latest mono in mono-calgary.git (commit 0fc6db6), and gives an error:

Unhandled error launching soft debugger
Mono.Debugger.Soft.VMDisconnectedException: Exception of type 'Mono.Debugger.Soft.VMDisconnectedException' was thrown.

To reset your mono-calgary.git back to a mono version that is compatible with the debugger in MonoDevelop 2.2.1, do (note that this will delete any changes you have made in mono-calgary) (Note that this is probably not necessary with the current 20101008 mono-calgary):

mono-calgary$ git reset --hard d7222b2b8e58b6488e21ca2bd65fd6e1e4b8f126
mono-calgary$ ./checkout-and-build-mono

When debugging, if Monodevelop freezes, you may be able to get it back. Go to the terminal from which you started Monodevelop. It may say something like

[6]+  Stopped                 monodevelop
$

If so, try running:

$ fg

Unit tests

Unit tests ran be run and debugged using monodevelop. To show the unit tests of your open projects, choose View > Unit Tests.

You can also run unit tests from terminal using nant and nunit (see Build_FieldWorks#Unit_tests).


When running unit tests in monodevelop, if you get the internal error:

FileNotFoundException: Could not load file or assembly 'nunit.core.interfaces ...' or one of its dependencies.

or

TypeLoadException: Could not load type 'NUnit.Core.NTrace' from assembly 'nunit.util'.

then for now do

Output/Debug$ rm nunit.core.dll

and try again.


If you get the error:

System.TypeLoadException: Could not load type 'NUnit.Core.TestCaseResult' from assembly 'nunit.core.interfaces, ...

do

Output/Debug$ rm nunit.core.interfaces.dll

If you get the error:

ConfigurationErrorsException: Type 'System.Configuration.NameValueSectionHandler' not found.

in, say, FwCoreDlgsTests, then edit the corresponding foo.dll.config in Output/Debug, such as Output/Debug/FwCoreDlgsTests.dll.config and change:

<section name="TestRunner" type="System.Configuration.NameValueSectionHandler"/>

to

<section name="TestRunner" type="System.Configuration.NameValueSectionHandler, System"/>

This can be done to all of the unit test dll.config files at once by doing:

Output/Debug$ for config in *Tests.dll.config; do sed -i $config -e \
  's@"System.Configuration.NameValueSectionHandler"@"System.Configuration.NameValueSectionHandler, System"@'
  done

If running unit tests that derive from BaseTest produce a error such as

TestFixutreSetUp failed in FwFontDialogTests

then you may not have your default .NET runtime environment set properly. Refer to Install_and_use_Monodevelop#Configure for instructions. You may have recently rebuilt and reinstalled mono from mono-calgary.git; if so then you will need to setup the mono + mono-real wrapper script again.

Running and debugging FieldWorks in Monodevelop

To run or debug TE or Flex from Monodevelop:

  • In the Solution pane, right-click the solution and choose Add ▸ Add Existing Project. Navigate to and open Src/Common/FieldWorks/FieldWorks.csproj
  • Right-click the FieldWorks project and choose Options. Under Run click General. In the Parameters box, type "-proj .../Sena\ 2.xml -app Flex", where ".../Sena\ 2.xml" is a path to Sena 2.xml. Optionally substitute Flex with TE.
  • In the Environment Variables area, add a Variable "DISPLAY" with Value ":2". Click OK.
  • Right-click the FieldWorks project and choose Set As Startup Project.

Now if you Run or Debug, monodevelop will run or debug FieldWorks inside your :2 Xephyr window.

Debug a library

Unlike Visual Studio the project properties in Monodevelop don't have a Debug tab that would allow to specify an external program to start.

However, this can be done in the project properties, General/Custom Commands section. Add a project operation for "Execute" and select the executable there.

Note that you might have to specify the full path to the executable - at least on my machine a relative path didn't work when I tried to run NUnit as executable.

Debugging into Mono code

If you want to debug into mono code, you have to disable the debugging of project code only: in Monodevelop, go to Edit/Preferences, Debugger/General section and unselect "Debug project code only".

Debug broken dependencies

Mono is picky about chaining dependencies, even to DLLs you don't really need. The runtime is more picky than MonoDevelop, so occasionally something that runs fine under MD fails when run stand-alone.

One way to debug this is to use a command line like

MONO_LOG_LEVEL=debug mono Example.exe

This outputs a lot of debugging information including all the DLLs it loaded and all the places it tried to load ones it could not find.